Account & Transaction
Introduction
The Account and Transaction API gives access to the following information relating to an account:
- The Account Product
- Transaction history
- Balances
- Direct Debits
- Standing Orders
- Beneficiaries
- Scheduled Payments
- Offers
- Card Holder Names Endpoint (for ClearSpend corporate credit card users)
- Statements (For Credit Cards)
Each item above is accessed via a separate endpoint. Each of these is documented in detail with examples below.
Throughout the documentation we presume you are a developer wanting to build an application "the client application" to consume customer data.
Prerequisites
Partner Access
All of our APIs are available for consumption by our business partners. If you are not already a partner and want to become one, please get in touch via the contact us page to request access.
Regulatory Access
Regulatory users are automatically granted access to this API. The steps to gain access are:
- You must be registered with the relevant competent authority as an Account Information Service Provider (AISP). In the UK that is the Financial Conduct Authority (FCA).
-
You must have valid transport and signing certificates uploaded to the UK Open Banking Implementation Entity (OBIE) Directory. These can be:
- OB Transport and OB Signing certificates issued by the OBIE
- OBWAC and OBSEAL ETSI format certificates issued by the OBIE
- QWAC and QSEAL PSD2 qualified eIDAS certificates issued by a PSD2 Qualified Trust Service Provider (QTSP) only applies to non-UK-registered TPPs
-
You must be on-boarded with NatWest Group as a Third Party. This can be done via the
Dynamic Client Registration
endpoint. The Dynamic Client Registration endpoint will determine which OAuth Token Endpoint Authentication method you should use, based on the transport and signing certificates. It will be:
-
tls_client_authif you have OB Transport and OB Signing certificates. This is our FAPI certified implementation . -
private_key_jwtif you have OBWAC or OBSEAL ETSI format certificates (or QWAC and QSEAL for non-UK-registered TPPs)
-
Customer Consent
Gathering customer consent is the first step of the API journey. Each customer must consent to allow you to access their accounts, where a consent is an agreement between you as the application owner and the customer.
Once consent is agreed between you and the customer, your client application initiates the request for access to the customer's accounts, with authentication and request confirmation happening on the bank's web or mobile platform.
The design of the API ensures that a customer's credentials are never shared with you, so they can be reassured that their credentials remain confidential at all times.
Gaining Access to Customer Data
The process of gaining access to a customer's data is a multi-step process, all of which must be completed.
- Step 1 . Obtain an access token using a signed JWT private_key_jwt method
- Step 2 . You use this Access Token to register your intent with us to request access to customer account data.
- Step 3 . The customer is redirected by you to our authentication portal where they authenticate and view the access request.
- Step 4 . The customer has the option to select one or more accounts, before confirming (or declining) your access request.
- Step 5 . The customer is redirected back to your site or application and you receive an authorisation code.
- Step 6 . You exchange this authorisation code for an Access Token specific to the access request.
- Step 7 . You use that Access Token to access the customer's account data.
Obtaining an Access Token Using private_key_jwt
Firstly, you obtain an Access Token using the OAuth 2.0 Client Authentication private_key_jwt method, signing the JWT with the same signing certificate uploaded to the UK Open Banking Implementation Entity (OBIE) Directory.
When requesting a token you must pass one or more of the OAuth Scopes you have been granted. You may register multiple consents (potentially containing different scopes) using a single Access Token. Remember to present your transport cert when making each request. See Mutual TLS for more information. The implementation will be client specific; please refer to your client documentation.
Example
Example request:
POST https://secure1t.natwest.com/as/token.oauth2 HTTP/1.1
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=ISO-8859-1
grant_type=client_credentials
&scope=accounts
&client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer
&client_assertion=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2p3dC1pZHAuZXhhbXBsZS5jb20iLCJzdWIiOiJtYWlsdG86bWlrZUBleGFtcGxlLmNvbSIsIm5iZiI6MTQ5OTE4MzYwMSwiZXhwIjoxNDk5MTg3MjAxLCJpYXQiOjE0OTkxODM2MDEsImp0aSI6ImlkMTIzNDU2IiwidHlwIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9yZWdpc3RlciJ9.SAxPMaJK_wYl_W2idTQASjiEZ4UoI7-P2SbmnHKr6LvP8ZJZX6JlnpK_xClJswAni1Tp1UnHJslc08JrexctaeEIBrqwHG18iBcWKjhHK2Tv5m4nbTsSi1MFQOlMUTRFq3_LQiHqV2M8Hf1v9q9YaQqxDa4MK0asDUtE_zYMHz8kKDb-jj-Vh4mVDeM4_FPiffd2C5ckjkrZBNOK001Xktm7xTqX6fk56KTrejeA4x6D_1ygJcGfjZCv6Knki7Jl-6MfwUKb9ZoZ9LiwHf5lLXPuy_QrOyM0pONWKj9K4Mj7I4GPGvzyVqpaZUgjcOaZY_rlu_p9tnSlE781dDLuw
In this case the requested scope is
accounts
. This is the scope you require to access account data. Alternative scopes are available. For example
payment
to access payment services. The
client_assertion
JWT claims:
-
issandsubmust contain the client_id that you obtained during client on-boarding. See Prerequisites for details. -
kidmust match the Key ID of the signing certificate uploaded to the UK Open Banking Implementation Entity (OBIE) Directory.
Non-Base64 client_assertion JWT
{
"kid": "B8k7lIkZSVDNO0W_9wE_B5OGm28",
"typ": "JWS",
"alg": "PS256"
}
.
{
"sub": "wXxoy2tIuy4TbiDNsWOTVJ",
"aud": "https://secure1t.natwest.com/as/token.oauth2",
"iss": "wXxoy2tIuy4TbiDNsWOTVJ",
"exp": 1584373475,
"iat": 1584372875,
"jti": "8e36d28e-5eda-4bad-b500-58ef64e6b466"
}
.
<<signature>>
Response:
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Referrer-Policy: origin
Strict-Transport-Security: max-age=31536000; includeSubDomains
Cache-Control: no-cache, no-store
Pragma: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Set-Cookie: PF=DpKX8c9D7Bxl8prKqTOgUQ; Path=/as; Secure; HttpOnly; Domain=secure1t.natwest.com
Content-Encoding: gzip
Content-Type: application/json;charset=utf-8
Content-Length: 102
Date: Mon, 12 Nov 2018 09:54:27 GMT
Server: standalone/v1.0
Set-Cookie: f5avrbbbbbbbbbbbbbbbb=GIBFCB...; HttpOnly; secure
{
"access_token": "C5JMQLt0yLNPllTkRmLhJ6sTzlmv",
"token_type": "Bearer",
"expires_in": 599
}
The value of the
access_token
field in the body of this response is your Access Token which you use to register an account access request in the next step.
Registering an Account Access Request
Once authenticated, you must make an HTTP POST request to the
account-access-consents
endpoint to register your intent to access customer account data. This request contains details of the access you wish to obtain to the customer's account, including:
- Data Clusters (or permissions) requested on the customer's accounts. Examples include the ability to read transactions or read balances;
- First and last transaction dates and times you would like to access (optional);
- Number of days the access will remain valid (defaulted to ongoing if not provided).
At this stage the Account Access Request is in the
AwaitingAuthorisation
state. It cannot be used until it is confirmed by the customer.
The Account Request endpoint is protected by
Mutual TLS
. The Access Token you received during the previous stage must be passed as the
Authorization
header with every request to this endpoint.
- With the recent advancements in APIs, TPPs having the permission "NWGReadCreditCardInternalDetail" will be eligible to view Credit Card Missed payments information along with accounts api response. This will include accounts status and past due payments details. TPP needs to request onboarding team to enable access for Credit Card Missed Payments information for them.
Example
Example Account Access Request:
POST https://api.natwest.com/open-banking/v4.0/aisp/account-access-consents HTTP/1.1
Authorization: Wdi7eSGbZn58nKGdRsg3MjKzE4c7
x-fapi-customer-last-logged-time: Sun, 16 Sep 2018 11:43:31 UTC
x-fapi-customer-ip-address: 1.2.3.4
x-fapi-interaction-id: 855f6b6f-5f84-4d02-8946-8a3fd0ed6601
Content-Type: application/json
Accept: application/json
{
"Data": {
"Permissions": [
"ReadAccountsDetail",
"ReadBalances",
"ReadBeneficiariesDetail",
"ReadDirectDebits",
"ReadProducts",
"ReadStandingOrdersDetail",
"ReadTransactionsCredits",
"ReadTransactionsDebits",
"ReadTransactionsDetail",
"ReadScheduledPaymentsDetail",
"ReadStatementsBasic",
"ReadStatementsDetail"
],
"ExpirationDateTime": "2018-09-23T17:20:11.198Z",
"TransactionFromDateTime": "2012-01-11T00:00:00Z",
"TransactionToDateTime": "2018-01-20T00:00:00Z"
},
"Risk": {}
}
Example Response
Note:-
ConsentId
below is synonymous with Account Access Request Id:
HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
X-Frame-Options: DENY
x-fapi-interaction-id: 855f6b6f-5f84-4d02-8946-8a3fd0ed6601
Set-Cookie: f5avrbbbbbbbbbbbbbbbb=CKHOL...; HttpOnly; secure; Domain=api.natwest.com; Path=/open-banking/v4.0
Content-Encoding: gzip
Content-Type: application/json;charset=utf-8
Content-Length: 303
Date: Fri, 16 Nov 2018 08:57:56 GMT
Server:
{
"Data": {
"ConsentId": "c2158b0021ed42bbb64ee1cc2e534741",
"Permissions": [
"ReadAccountsDetail",
"ReadBalances",
"ReadBeneficiariesDetail",
"ReadDirectDebits",
"ReadProducts",
"ReadStandingOrdersDetail",
"ReadTransactionsCredits",
"ReadTransactionsDebits",
"ReadTransactionsDetail",
"ReadScheduledPaymentsDetail",
"ReadStatementsBasic",
"ReadStatementsDetail"
],
"CreationDateTime": "2018-09-16T17:20:11.198Z",
"ExpirationDateTime": "2018-09-23T17:20:11.198Z",
"TransactionFromDateTime": "2012-01-11T00:00:00Z",
"TransactionToDateTime": "2018-01-20T00:00:00Z",
"Status": "AWAU"
},
"Risk": {
},
"Links": {
"Self": "https://api.natwest.com/open-banking/v4.0/aisp/account-access-consents/c2158b0021ed42bbb64ee1cc2e534741"
},
"Meta": {
}
}
Confirming the Account Access Request
The next step is to obtain confirmation from the customer for your access request. To achieve this you redirect the customer to our authentication portal where they log in using their banking credentials, view your access request and confirm or decline it. The access is now in the
Authorised
state.
Next, an Authorisation Code is generated by us, and the customer is redirected back to you. The Authorisation Code is provided to you as part of that redirect.
The process is detailed below, step by step.
The Authorisation Request
Firstly, you make a call to our Authorisation endpoint. The address of this endpoint is available in the Open Banking Directory. This endpoint is HTTPS, protected with TLS and HSTS. During this stage you redirect the customer's browser to our Authorisation endpoint to initiate the process of obtaining the customer's confirmation.
A detailed summary of our authorisation servers (including use of Universal Links / Application links) can be found here .
When making the request your client application constructs and passes us a redirect URL. The Authorisation Request URL you construct and invoke at this stage has a specific form. It must contain:
-
Your
client_id -
A
response_typeof 'code id_token'. -
A
code_challenge_methodandcode_challengequery parameter (see PKCE RFC ) -
An OpenID Connect object in the
requestquery parameter in the form of a signed JWT.
The signed JWT must contain a set of mandatory claims including the Intent ID obtained as part of the Account Request API invocation and a
redirect_uri
parameter.
The location of the Redirect URI is used to return the customer to you once access has been granted using our authentication portal. The root of the redirect URI must match that registered by you at registration time. See Prerequisites for details on registration.
You must sign the JWT containing all the claims using the signing certificate ("sig" key) issued by the relevant Certificate Authority, for example the OBIE in the UK. See the example request below and the Open ID Connect Specification for details.
Note:- At this time the NatWest Authorisation endpoint only supports use of RSA256 for JWT signing.
Example
Example Authorisation Request. This example uses
https://developer.natwest.com/dummy_redirect.htm
as an example redirect URL:
GET https://secure1t.natwest.com/as/authorization.oauth2?client_id=7xPKBspndegEsfR2f2Fss2s&response_type=code%20id_token&code_challenge_method=S256&code_challenge=GGQfwpOUSD3-TbAC0jbrUR-CdLKuY5grWwGjTP4Hzwk&request=eyJraWQiOiJQWnJ3RUl3VW8ydmhyajBEZU0xOWNLUVNOczQiLCJ0eXAiOiJKV1MiLCJhbGciOiJSUzI1NiJ9.eyJjb25zZW50UmVmSWQiOiJjMjE1OGIwMDIxZWQ0MmJiYjY0ZWUxY2MyZTUzNDc0MSIsInNjb3BlIjoib3BlbmlkIGFjY291bnRzIiwiYWNyX3ZhbHVlcyI6InVybjpvcGVuYmFua2luZzpwc2QyOmNhIiwiaXNzIjoiNnhQVUh4bVNtTjhsZkwyRmJ6dXgzcyIsImNsYWltcyI6eyJpZF90b2tlbiI6eyJhY3IiOnsiZXNzZW50aWFsIjp0cnVlfSwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjp7InZhbHVlIjoiYzIxNThiMDAyMWVkNDJiYmI2NGVlMWNjMmU1MzQ3NDEiLCJlc3NlbnRpYWwiOnRydWV9fSwidXNlcmluZm8iOnsiYWNyIjp7ImVzc2VudGlhbCI6dHJ1ZX0sIm9wZW5iYW5raW5nX2ludGVudF9pZCI6eyJ2YWx1ZSI6ImMyMTU4YjAwMjFlZDQyYmJiNjRlZTFjYzJlNTM0NzQxIiwiZXNzZW50aWFsIjp0cnVlfX19LCJyZXNwb25zZV90eXBlIjoiY29kZSBpZF90b2tlbiIsInJlZGlyZWN0X3VyaSI6Imh0dHBzOlwvXC9kZXZlbG9wZXIubmF0d2VzdC5jb21cL2R1bW15X3JlZGlyZWN0Lmh0bSIsInN0YXRlIjoiYWJjZDEyMzQiLCJleHAiOjE1NDIwMTY3NjksIm5vbmNlIjoiOWVkY2MxN2ItOGQxMy00YjgzLTgzZWEtM2RlYjEwNDhlMzQ0IiwiY2xpZW50X2lkIjoiNnhQVUh4bVNtTjhsZkwyRmJ6dXgzcyJ9.gMB_qpu4_2mE-mNTiEyBIlwSuDjIZ60rWLb6kSWavbEOR9p9TBatddVb_M6B1pr6Tz7pr0mgMWn4_i4T5TGewwCNHKbD-pgVLLX4-_R9XD8UBk-a6fUOHEoksWdePN-1WEJ0tapUnvZwPwx_uzjl6deIrYHC5mb6FlRHLGp4XIBKv-plM2-SHf7TR5WXzM0r-XBBUjH5dFWCx5R7TGVnOc7x4kaqu7Cah3js7qv1yAJMoue-BP3oeUeReBlzO-0ziUwbXiAeHeHRpXWlYCqJ5RvBsLQyrOp1P49rUZRdx_mnqnhZWBGAiABALzJ3HDNXEIXm6tSqhmBtZfcsTl-_Cw&nonce=9edcc17b-8d13-4b83-83ea-3deb1048e344 HTTP/1.1
Accept: text/html
Host: secure1t.natwest.com
Body: <none>
The request claims are base64url encoded within the
request
query parameter. (They can be decoded using
JWT.io
).
Note:-
consentRefId
and
openbanking_intent_id
below are synonymous with Account Access Request Id:
{
"kid": "12345",
"typ": "JWS",
"alg": "PS256"
}
{
"consentRefId": "c2158b0021ed42bbb64ee1cc2e534741",
"scope": "openid accounts",
"acr_values": "urn:openbanking:psd2:ca",
"iss": "7xPKBspndegEsfR2f2Fss2s",
"claims": {
"id_token": {
"acr": {
"essential": true
},
"openbanking_intent_id": {
"value": "c2158b0021ed42bbb64ee1cc2e534741",
"essential": true
}
},
"userinfo": {
"acr": {
"essential": true
},
"openbanking_intent_id": {
"value": "c2158b0021ed42bbb64ee1cc2e534741",
"essential": true
}
}
},
"response_type": "code id_token",
"redirect_uri": "https://developer.natwest.com/dummy_redirect.htm",
"state": "abcd1234",
"exp": 1542016769,
"nonce": "9edcc17b-8d13-4b83-83ea-3deb1048e344",
"client_id": "7xPKBspndegEsfR2f2Fss2s"
}
Authorisation Endpoint Response
Once the customer has confirmed the access request we redirect the customer's browser to the Redirect URL you provided. We append this URL with a hash fragment containing the Authorisation Code (
code
) and an id_token in the form of a signed JWT. Next, you will exchange the Authorisation Code for a set of credentials used to access the accounts confirmed by the customer.
Note:- At this time the NatWest Authorisation endpoint uses RSA256 for ID Token signing.
To remain FAPI compliant you must verify the signature of the signed JWT using the public key available from our JWKS endpoint. The location of our JWKS endpoint is the value of the
jwks_uri
attribute available from our
.well-known
endpoint.
The value of the
sub
and
openbanking_intent_id
claims in this JWT are the related Account Access Request ID. This enables you to correlate the response with the requested Account Access Request. Additionally the
c_hash
and
s_hash
fields contain, respectively, hashes of the passed in
state
parameter and returned
code
parameter. For more details on the
c_hash
see the
Open ID Connect
documentation. For
s_hash
see the
FAPI
documentation.
Example
Example Authorisation Response
https://developer.natwest.com/dummy_redirect.htm#code=vRZs_yPSuzsap3BIW9w7CmzgEgJ3MFCsLVkAAAAE&id_token=eyJhbGciOiJSUzI1NiIsImtpZCI6Ikg4OVBtWGx0VXVlVmFLLS1uVlNZM2c2SlBxYyJ9.eyJzdWIiOiJjMjE1OGIwMDIxZWQ0MmJiYjY0ZWUxY2MyZTUzNDc0MSIsImF1ZCI6IjZ4UFVIeG1TbU44bGZMMkZienV4M3MiLCJqdGkiOiJkdmZoUXhlV3ZxNzZnc082OXhLRjcwIiwiaXNzIjoiaHR0cHM6Ly9pYW0tYXV0aG4tc2l0LW53Yi5tYW5hZ2VkdGVzdC5jb20iLCJpYXQiOjE1NDIwMTY0NzgsImV4cCI6MTU0MjAxNjc3OCwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjoiYzIxNThiMDAyMWVkNDJiYmI2NGVlMWNjMmU1MzQ3NDEiLCJub25jZSI6IjllZGNjMTdiLThkMTMtNGI4My04M2VhLTNkZWIxMDQ4ZTM0NCIsImF1dGhfdGltZSI6MTU0MjAxNjQ3OCwiY19oYXNoIjoiazB1QlhqbF9pdF9tT2JvRE5wSTR1USIsInNfaGFzaCI6IjZjN25Hcmt5X2Voak00MEl2azNwM3cifQ.AycZlfTkTuHhEW_7GyWU_h12XszrNzs4Z47tPA9xPRcjpPG-ret7oNhi1pMlO2uiC7VcXPd_uwg_6V7KbKEj8CkpZ3IRibAMgF12OhNUaYRL8Kboopic9JpvU4SH0wgR4_SfixusjQYm2a7MsT11FFA7vvzZzKDh0mW8NRkin3tZ4PWoD-4NAuO8OFHtQ5ZTCSNqwASXdQlUyuiNYW1xq26irLhmD5E4u6g02urcKB5BCGsqEByVddYlqNB2TwNyJBz3kW033X__icIWEe9isJHqtXhe-7y2wrEHVLwDVTZzN2Z5dXPVJB82JEsXl_qeVTdpDJNdZB7n1HeIIBB6jA&state=abcd1234
The response claims are encoded within the
id_token
query parameter. (They can be decoded using
JWT.io
):
Note:-
openbanking_intent_id
below is synonymous with Account Access Request Id:
{
"sub": "c2158b0021ed42bbb64ee1cc2e534741",
"aud": "7xPKBspndegEsfR2f2Fss2s",
"jti": "dvfhQxeWvq76gsO69xKF70",
"iss": "https://secure1t.natwest.com",
"iat": 1542016478,
"exp": 1542016778,
"openbanking_intent_id": "c2158b0021ed42bbb64ee1cc2e534741",
"nonce": "9edcc17b-8d13-4b83-83ea-3deb1048e344",
"auth_time": 1542016478,
"c_hash": "k0uBXjl_it_mOboDNpI4uQ",
"s_hash": "6c7nGrky_ehjM40Ivk3p3w"
}
Exchanging an Authorisation Code for an Access Token
In this step the token endpoint is authenticated with private key JWT to exchange the authorisation code generated during the authorisation process for an Access Token, similar to the access token created earlier to register intent . This endpoint is protected by Mutual TLS . On submission of an authorisation code it returns:
- An Access Token;
- A Refresh Token;
- A signed JWT containing, amongst other things, the Account Access Request ID corresponding to the returned Access Token.
Note:- At this time the NatWest Authorisation endpoint uses RSA256 for ID Token signing.
You can use the latter to correlate the response with the request. To that end, the
sub
and
openbanking_intent_id
claims contain the related Intent ID. Additionally the
c_hash
and
s_hash
fields contain, respectively, hashes of the passed in
state
and
code
parameters. For more details on the
c_hash
see the
Open ID Connect
documentation. For s_hash see the
FAPI
documentation.
The Access Token has fixed validity. See Access Token/Refresh Token Exchange for details on obtaining a new token once the original expires.
Code Verifier and PKCE
The token endpoint requires each request to include a
code_verifier
as per the
PKCE RFC
to prevent man-in-the-middle attacks.
Example
Example Request:
POST https://secure1t.natwest.com/as/token.oauth2 HTTP/1.1
Accept: */*
Content-Type: application/x-www-form-urlencoded; charset=ISO-8859-1
grant_type=authorization_code
&code_verifier=RczZn-l7WMCUIiKQLNcWBXHVNfb1_IR25rGwY1nNAt8
&code_challenge_method=S256
&code=vRZs_yPSuzsap3BIW9w7CmzgEgJ3MFCsLVkAAAAE
&redirect_uri=https://developer.natwest.com/dummy_redirect.htm
&client_id=7xPKBspndegEsfR2f2Fss2s
&client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer
&client_assertion=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2p3dC1pZHAuZXhhbXBsZS5jb20iLCJzdWIiOiJtYWlsdG86bWlrZUBleGFtcGxlLmNvbSIsIm5iZiI6MTQ5OTE4MzYwMSwiZXhwIjoxNDk5MTg3MjAxLCJpYXQiOjE0OTkxODM2MDEsImp0aSI6ImlkMTIzNDU2IiwidHlwIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9yZWdpc3RlciJ9.SAxPMaJK_wYl_W2idTQASjiEZ4UoI7-P2SbmnHKr6LvP8ZJZX6JlnpK_xClJswAni1Tp1UnHJslc08JrexctaeEIBrqwHG18iBcWKjhHK2Tv5m4nbTsSi1MFQOlMUTRFq3_LQiHqV2M8Hf1v9q9YaQqxDa4MK0asDUtE_zYMHz8kKDb-jj-Vh4mVDeM4_FPiffd2C5ckjkrZBNOK001Xktm7xTqX6fk56KTrejeA4x6D_1ygJcGfjZCv6Knki7Jl-6MfwUKb9ZoZ9LiwHf5lLXPuy_QrOyM0pONWKj9K4Mj7I4GPGvzyVqpaZUgjcOaZY_rlu_p9tnSlE781dDLuw
Example Response:
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Referrer-Policy: origin
Strict-Transport-Security: max-age=31536000; includeSubDomains
Cache-Control: no-cache, no-store
Pragma: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Set-Cookie: PF=PlYIYZCdLmfm8mO5e9yLNc; Path=/as; Secure; HttpOnly; Domain=secure1t.natwest.com
Content-Encoding: gzip
Content-Type: application/json;charset=utf-8
Content-Length: 868
Date: Mon, 12 Nov 2018 09:54:38 GMT
Server: standalone/v1.0
Set-Cookie: f5avrbbbbbbbbbbbbbbbb=MDIH...; HttpOnly; secure
{
"access_token": "zlJojElfSalTBc1CKVwi3adSHPpr",
"refresh_token": "EhRx3DsdmpU4J8ISVBeVYj5v5l2I2oDorfEVgbPcft",
"scope": "openid accounts",
"id_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6Ikg4OVBtWGx0VXVlVmFLLS1uVlNZM2c2SlBxYyJ9.eyJzdWIiOiJjMjE1OGIwMDIxZWQ0MmJiYjY0ZWUxY2MyZTUzNDc0MSIsImF1ZCI6IjZ4UFVIeG1TbU44bGZMMkZienV4M3MiLCJqdGkiOiJkdmZoUXhlV3ZxNzZnc082OXhLRjcwIiwiaXNzIjoiaHR0cHM6Ly9pYW0tYXV0aG4tc2l0LW53Yi5tYW5hZ2VkdGVzdC5jb20iLCJpYXQiOjE1NDIwMTY0NzgsImV4cCI6MTU0MjAxNjc3OCwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjoiYzIxNThiMDAyMWVkNDJiYmI2NGVlMWNjMmU1MzQ3NDEiLCJub25jZSI6IjllZGNjMTdiLThkMTMtNGI4My04M2VhLTNkZWIxMDQ4ZTM0NCIsImF1dGhfdGltZSI6MTU0MjAxNjQ3OCwiY19oYXNoIjoiazB1QlhqbF9pdF9tT2JvRE5wSTR1USIsInNfaGFzaCI6IjZjN25Hcmt5X2Voak00MEl2azNwM3cifQ.AycZlfTkTuHhEW_7GyWU_h12XszrNzs4Z47tPA9xPRcjpPG-ret7oNhi1pMlO2uiC7VcXPd_uwg_6V7KbKEj8CkpZ3IRibAMgF12OhNUaYRL8Kboopic9JpvU4SH0wgR4_SfixusjQYm2a7MsT11FFA7vvzZzKDh0mW8NRkin3tZ4PWoD-4NAuO8OFHtQ5ZTCSNqwASXdQlUyuiNYW1xq26irLhmD5E4u6g02urcKB5BCGsqEByVddYlqNB2TwNyJBz3kW033X__icIWEe9isJHqtXhe-7y2wrEHVLwDVTZzN2Z5dXPVJB82JEsXl_qeVTdpDJNdZB7n1HeIIBB6jA",
"token_type": "Bearer",
"expires_in": 599
}
The response claims are base64url encoded within the value of
id_token
in the response body. (They can be decoded using
JWT.io
).
Note:-
openbanking_intent_id
below is synonymous with Account Access Request Id:
{
"alg": "PS256",
"kid": "abcd-1234"
}
{
"sub": "c2158b0021ed42bbb64ee1cc2e534741",
"aud": "7xPKBspndegEsfR2f2Fss2s",
"jti": "dvfhQxeWvq76gsO69xKF70",
"iss": "https://secure1t.natwest.com",
"iat": 1542016478,
"exp": 1542016778,
"openbanking_intent_id": "c2158b0021ed42bbb64ee1cc2e534741",
"nonce": "9edcc17b-8d13-4b83-83ea-3deb1048e344",
"auth_time": 1542016478,
"c_hash": "k0uBXjl_it_mOboDNpI4uQ",
"s_hash": "6c7nGrky_ehjM40Ivk3p3w"
}
Accessing Customer Data
Once the Account Access Request has been confirmed and you have the necessary tokens, you may access the customer's account(s) via the APIs. Multiple authorisation records containing different data clusters may be active for any given customer and client application at any one time. The token pertaining to the correct access request must be passed with every API request, even if multiple access requests are active.
The API specifications further down this page contain request/response examples, including tokens, for each endpoint.
Access Validity Period
Confirmation to access the customer's account is dependent to expiry date in the request. Any confirmation given by a customer is valid for the period requested by you or ongoing if expiry date in the request is not provided.
Security Considerations
The APIs are protected by a number of standards-based controls both at the application level and the network level.
TLS Requirements
All endpoints are secured using Transport Layer Security (TLS1.2). Browser based journeys are HTTPS with HSTS.
Ciphers
The Open Banking Directory will only support the generation of certificates using RSA.
The FAPI Read Write Specification specifies the algorithms that should be used for TLS (Section 8.5) and for digital signatures (Section 8.6).
In accordance with Section 8.5, only the following ciphers will be supported for TLS:
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
Mutual TLS
All API endpoints (excluding the browser based consent authentication journey) require you to authenticate yourselves using mTLS by passing your X.509 digital certificate. You must send the entire certificate chain with the certificate otherwise the request will be rejected with a 403 error code.
API Endpoints
Each API endpoint delivering customer data is protected by the following controls:
- Mutual Transport Layer Security (TLS1.2)
- Access Token - The OAuth Access Token must be valid and belong to the client application initiating the request.
- Access confirmation - The Access Token and Intent ID associated with the data request must correlate with one another. Furthermore, the data clusters held in the access token must allow access to the requested resource(s).
- Scope - The scope of the Access Token must correspond to the scope required to access that particular API endpoint. In the case of the Account and Transactions API this is the AISP scope.
Required Headers
We recommend passing a globally unique
x-fapi-interaction-id
header to be used as a correlation ID, this should be unique for each and every interaction with us. If no
x-fapi-interaction-id
header is passed one will be generated by us. The generated value will be a GUID. In either case the value of this header is returned in the response.
Note:- Please include the x-fapi-interaction-id in any support requests. It will greatly expedite the investigation.
Refreshing an Access Token
Each Access Token lasts for only a limited period. Once expired, the Refresh Token must be used to generate a new Access Token. This can happen any number of times while the Refresh Token remains valid. Tokens are refreshed using the Token endpoint. This endpoint is protected by Mutual TLS and uses the private key jwt authentication method as seen earlier .
Example Refresh Request:
POST https://secure1t.natwest.com/as/token.oauth2 HTTP/1.1
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=ISO-8859-1
grant_type=refresh_token
&client_id=7xPKBspndegEsfR2f2Fss2s
&refresh_token=EhRx3DsdmpU4J8ISVBeVYj5v5l2I2oDorfEVgbPcft
&client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer
&client_assertion=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2p3dC1pZHAuZXhhbXBsZS5jb20iLCJzdWIiOiJtYWlsdG86bWlrZUBleGFtcGxlLmNvbSIsIm5iZiI6MTQ5OTE4MzYwMSwiZXhwIjoxNDk5MTg3MjAxLCJpYXQiOjE0OTkxODM2MDEsImp0aSI6ImlkMTIzNDU2IiwidHlwIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9yZWdpc3RlciJ9.SAxPMaJK_wYl_W2idTQASjiEZ4UoI7-P2SbmnHKr6LvP8ZJZX6JlnpK_xClJswAni1Tp1UnHJslc08JrexctaeEIBrqwHG18iBcWKjhHK2Tv5m4nbTsSi1MFQOlMUTRFq3_LQiHqV2M8Hf1v9q9YaQqxDa4MK0asDUtE_zYMHz8kKDb-jj-Vh4mVDeM4_FPiffd2C5ckjkrZBNOK001Xktm7xTqX6fk56KTrejeA4x6D_1ygJcGfjZCv6Knki7Jl-6MfwUKb9ZoZ9LiwHf5lLXPuy_QrOyM0pONWKj9K4Mj7I4GPGvzyVqpaZUgjcOaZY_rlu_p9tnSlE781dDLuw
Example Response:
HTTP/1.1 200 OK
Content-Encoding: gzip
Content-Type: application/json;charset=utf-8
Content-Length: 102
{
"access_token": "x2gZxLWT3QkzAcXPrRMJVZXDGfJG",
"refresh_token": "Whrc0SFjBRjqVW0cP5lUic7zC3YknTwPq2ItvTPfDN",
"token_type": "Bearer",
"expires_in": 599
}
Access and Refresh Token Validity Period
Each Access Token lasts 10 minutes. The latest Refresh Token will last until exchanged for a new Access and Refresh Token.
Balances
Balances returned from the API will have one of two types. See below for an explanation of how each type is computed and what sort of transactions are taken into consideration.
Expected
Balance of the customer’s account (booked and pending items) including the following:
- Cash withdrawals
- Cash deposits
- Faster Payments
- Pending authorisations
- Point of sale transactions
- Forward posted transactions
- Available overdraft (for accounts outside of the scope of HCC*)
If an account has an overdraft this will have CreditLine/Included set as False for accounts in scope of HCC* and True for non-HCC* accounts in our API response, and the CreditDebitIndicator will be either Credit or Debit based on the balance.
Credit card
Balance of the customer’s credit limit taking the money spent on the card into account (credit agreed minus amount spent). This will have CreditLine/Included set as True in our API response, and the CreditDebitIndicator will be Debit.
ForwardAvailable
Balance of the customer’s account (booked) plus:
- Cash withdrawals
- Cash deposits
- Faster Payments
- Forward posted transactions
If an account has an overdraft this will have CreditLine/Included set as False in our API response, and the CreditDebitIndicator will be either Credit or Debit based on the balance.
Credit card
How much has been spent on the card, including pending transactions. There will be no CreditLine information in our API response, and the CreditDebitIndicator will be Debit when there is a balance to be paid back on the card, or is zero, or will be Credit when the balance has been overpaid.
Beneficiaries
Beneficiary Type
Each beneficiary has an optional beneficiary type.
If the type is not set then the beneficiary is trusted.
Transactions Endpoint
The transactions endpoint returns a customer's transaction data, optionally restricted to a particular period of time.
Transaction Statuses & Mutability
The 'status' field of a transaction can be one of the following: 'BOOK', 'PDNG', 'FUTR' or 'INFO'. Transactions start as 'PDNG' until they have been posted, at which point they become 'BOOK'.
Before a transaction has been posted it is mutable and some fields may change. 'PDNG' transactions are all mutable until they get posted. A 'BOOK' transaction is immutable by default but this can be specified using an optional 'TransactionMutability' flag. This flag can have a value of either 'mutable' or 'immutable'. For more details around transaction mutability see the Open Banking specification . This flag is not present in the default cases.
To align with the transaction statuses provided by Mobile Banking, the status of intra-day transactions that have not yet posted will be set to 'BOOK'. These transactions can still change, so they will have a TransactionMutability flag set to 'mutable'. Once an intra-day transaction has posted, it will have a status of 'BOOK' and no TransactionMutability flag.
Only transactions that are 'BOOK' and immutable will have a transaction ID. This is a unique ID that won't change. The ID can be used to ensure that a given transaction is the same across different calls to the API. Transactions that have other statuses and transactions that are 'BOOK' but mutable will not have an ID.
The following table outlines the possible combinations:
| Transaction Status | TransactionMutability Flag | Mutability Status | Has Transaction ID |
|---|---|---|---|
| PDNG | N/A | Mutable | No |
| BOOK | Mutable | Mutable | No |
| BOOK | None | Immutable | Yes |
The following table lists the transaction codes for intra-day payments:
| Code | Description |
|---|---|
| BAC | Automated Credit |
| BSP | Branch Single Payment |
| C/L | Cash Withdrawal |
| C/R | Credit Remittance |
| CDM | Cash & Deposit Machine |
| CHG | Account Charges |
| CHP | CHAPS Transfer |
| D/D | Direct Debit |
| DIV | Dividend |
| DPC | Online Transaction |
| EBP | Bill Payment |
| IBP | Inter Branch Payment (Transfer) |
| INT | Interest |
| ITL | CHAPS/International Payment |
| NDC | No Dividend C/foil |
| POC | Post Office Counters |
| S/O | Standing Order |
| SBT | Transfer - Funds Transfer |
| TLR | Teller Transaction |
| TSU | Telephone Banking |
Transaction Types
There are different types of transactions, and a particular transaction's type is not fixed and may change with time. The following table outlines the relevant transaction types:
| Transaction Type | Description |
|---|---|
| Pending | A transaction that is currently being processed |
| Posted | A transaction that has been processed |
| Forward posted | A transaction that will be processed on a particular date |
Transaction Codes
The following table lists all possible ProprietaryBankTransactionCode/Code values:
| Code | Description |
|---|---|
| ADV | Separate Advice |
| AMD | Amendments History |
| BAC | Automated Credit |
| BAE | Branch Acc Entry |
| BCA | Clean Acceptance |
| BCO | Non Mkt Close Out |
| BCR | Clean Reimburse |
| BGC | Credit |
| BGT | Guarantees |
| BOE | Bill of Exchange |
| BSP | Branch Single Payment |
| C/L* | Cash Withdrawal |
| C/R | Credit Remittance |
| CAE | Cheque Collection |
| CARD* | Card Payment or Cash |
| CCB | Cheque Collection |
| CCD | Cheque at Despatch |
| CDM | Cash & Deposit Machine |
| CHG | Account Charges |
| CHG TO | Charges |
| CHP | CHAPS Transfer |
| CHQ | Cheque |
| CNA | Clean Cheque Neg |
| CND | Cheque Negotiation |
| D/C | Credit |
| D/D | Direct Debit |
| DCR | Documentary Credit |
| DFT | Foreign Draft |
| DIV | Dividend |
| DPC | Online Transaction |
| EBP | Bill Payment |
| ECA | eurocheque |
| ECD | eurocheque |
| IAT | Transfer |
| IBP | Inter Branch Payment (Transfer) |
| ICP | Inward Ccy Payment |
| IFT | Int Free Threshold |
| INT | Interest |
| INT TO | Interest |
| INTCTO | Interest |
| IPB | Inland Payments |
| IP** | Inland Payments |
| ISP | Inward Stg Payment |
| ITL | CHAPS/International Payment |
| ITM | Incoming CHAPS |
| LON | New Loan |
| LST | Bulk Entry |
| LVP | Low Value Payment |
| MEC | Export Credits |
| MFD | Maturing Fwd Deal |
| MGT | Bonds & Guarantees |
| MIB | Inward Bills |
| MIC | Import Credits |
| MKD | Market Deal |
| MOB | Outward Bills |
| MSC | Standby Credits |
| NDC | No Dividend C/foil |
| NOS | Overseas |
| NVD | Novated Deal |
| ODL | Overdraft Limit |
| ODR | Overdraft Rate |
| OSE | Overseas |
| OTM | Outgoing CHAPS |
| POC | Post Office Counters |
| POS | Card Transaction |
| PYR | Payment/Receipt |
| RFW | Transfer |
| RTF | Relay Transfer |
| RYD | Transfer |
| S/O | Standing Order |
| SBT | Transfer - Funds Transfer |
| SDE | Urgent Euro Tfr |
| STF | Standard Transfer |
| STL | Settlement |
| TCA | T/Chq Negotiation |
| TCD | T/Chq Negotiation |
| TFP | Trade Fin Product |
| TFR | Transfer |
| TLR | Teller Transaction |
| TMS | Overseas - travel money service |
| TSU | Telephone Banking |
| U/D | Unpaid Direct Debit |
| UTF | Urgent Transfer |
| VCS | Visa Cash |
Credit card
| Code | Description |
|---|---|
| PR | PURCHASE |
| CA | CASH |
| FE | FEE |
| PY | PAYMENT |
*These transaction codes may be followed by a space and a single digit number. For example 'C/L 1' or 'CARD 5'.
**This transaction code is followed by a single digit number. For example 'IP3'.
Transaction Filtering
The transaction data returned from this endpoint will be filtered based on the transaction type and whether it is a working day or not. The below table shows the different possibilities. A blank 'toBookingDateTime' field is treated as if it was populated with today's date. The 'fromBookingDateTime' field is ignored for filtering purposes.
| toBookingDateTime | Type of day | Transactions returned |
|---|---|---|
| Today (or blank) | Working day | All transactions |
| Today (or blank) | Non-working day | Pending and posted transactions |
| Before today | Working day | Posted transactions only |
| Before today | Non-working day | Posted transactions only |
Due to this filtering mechanism, fewer than the usual maximum number of transactions may be returned per page. There may still be more transactions available on later pages. Check for the presence of the next page field - if it is present, there are more transactions on that page.
Transaction date history availability
Requests for full transaction date history will only be fulfilled within the first 60 minutes of customer consent authentication. Outside this authentication period, requests for transaction history will be limited to the last 90 days only.
Where more than 60 minutes since customer consent authentication has elapsed:
- Requests sent where the fromBookingDateTime, in the request or consent, is prior to 90 days ago will only receive transaction data for the last 90 days in the API response.
- Requests sent where the toBookingDateTime, in the request or consent, is prior to 90 days ago will receive a 403 API response.
However, TPPs can request customer re-authentication, enabling them to also request full transaction date history for a further 60 minutes.
Card Holder Names Endpoint (for ClearSpend corporate credit card users)
This API endpoint provides card holder names for ClearSpend corporate credit card users.
The endpoint returns a list of the card holder's name along with accountid and the card's last 4-digit number, which is associated with the admin account. The information provided includes cardLast4, accountId, name, accountType and expirationDate.
The card holder's information can be retrieved via GET API: open-banking/v4.0/aisp/accounts/{accountId}/card-holder-names.
Example response:
{
"Data": {
"AccountId": "E6C604494E9B87B95B497C79BAA4BD88",
"CompanyId": "0024824",
"Company": [
{
"cardLast4": "9966",
"accountId": "80000021506",
"name": "NOS CORPIIX",
"accountType": "CORPORATE",
"expirationDate": "2025-06-02"
},
{
"cardLast4": "0014",
"accountId": "00000034294",
"name": "NOS CARD 3",
"accountType": "INDIVIDUAL",
"expirationDate": "2025-06-02"
}
]
},
"Links": {
"Self": "https://sit-api.natwest.com/open-banking/v4.0/aisp/accounts/E6C604494E9B87B95B497C79BAA4BD88/card-holder-names"
},
"Meta": {
}
}
Statements Endpoint
The statement endpoint returns historical statement information on an account. Information includes statement dates, previous balances, purchase totals, payment information and more.
The statement information can be retrieved via GET /{accountId}/statements endpoint.
The TPPs having the permission "NWGReadCreditCardInternalDetail" will be eligible to view Credit Card payments information such as payments status (i.e No Pmt, Min Pmt, Full Pmt. etc) and Payment Timing (Late, Early, On-Time. etc) along with statements api response.
** Currently this feature is present for only credit card accounts.
Accessing the above endpoint for a savings or a MTA account will result in status code 403.
The following table shows various amount types returned as part of statement response:
| Balance Type | Description | Customer Type |
|---|---|---|
| UK.OBIE.ClosingBalance | Statement Balance | Personal & Business |
| UK.OBIE.MinimumPaymentDue | Minimum payment due balance | Personal |
| UK.OBIE.StartingBalance | Balance brought forward | Personal & Business |
| UK.OBIE.TotalCredits | Payments to account | Personal & Business |
| UK.OBIE.TotalPurchase | Spending plus adjustment | Personal & Business |
| UK.OBIE.CreditLimit | Card credit limit | Personal & Business |
| UK.OBIE.TotalCashAdvances | Cash advances | Personal & Business |
| UK.OBIE.TotalAdjustments | Adjustments | Business |
Statements Filtering
The statement data returned from this endpoint will be filtered based on the statement dates(
fromStatementDateTime
,
toStatementDateTime
) provided and whether a day is a working day or not.
A blank
toStatementDateTime
field is treated as if it was populated with today's date.
Due to this filtering mechanism, fewer than the usual maximum number of statement may be returned per page. There may still be more statements available on later pages. Check for the presence of the next page field to determine this - if it is present, there are more statements on that page.
There are few exceptions for Phase-1 delivery as mentioned below:
- Credit Card statement is available for last 3 months only.
- This API is currently designed to show Mandatory values for Phase-1, optional fields may or may not have values, few examples are TotalCashAdvances, TotalCredits, TotalCharges.
- Currently API has mismatch for field “Minimum Payment Due” with hard copy of credit card statement. This will be fixed in phase-2 next year.
Switched Out Current Accounts
The APIs will now indicate if an account on an active customer consent has switched to a different Account Servicing Payment Service Provider (ASPSP) using the Current Account Switching Service (CASS). This can be obtained via the GET /accounts and GET /accounts/{AccountId} endpoints.
Switched accounts will not appear on consent authorisation screen and as a result it will not be possible to authorise new consents to view switched accounts.
Once all consents containing a specific switched out account expire the Third Party Provider (TPP) will no longer be able to retrieve that switched accounts via the APIs.
Accessing other AISP endpoints, for example /balances or /transactions, using a switched account will result in 400 – Bad Request error.
A switched account will only be populated with an AccountId and a SwitchStatus value of “UK.CASS.SwitchCompleted”, no other fields will be included in the response.
Example response:
{
"Data": {
"Account": [
{
"AccountId": "D2FAW9C5DFCS7BB9F6AAC4FWS53",
"SwitchStatus": "UK.CASS.SwitchCompleted"
}
]
},
"Links": {
"Self": "https://api.rbs.co.uk/open-banking/v4.0/aisp/accounts"
},
"Meta": {
}
}
Functionality Matrix
The following table shows the functionality supported for each API version:
| Endpoint | Path | Functionality Supported | v1.1 | v2.0 | v3.1 | v4.0 |
|---|---|---|---|---|---|---|
| Get Accounts | /accounts | API available | ✔ | ✔ | ✔ | ✔ |
| Account Nickname | ❌ | ❌ | ✔ | ✔ | ||
| Get Account | /accounts/ | API available | ✔ | ✔ | ✔ | ✔ |
| Account Nickname | ❌ | ❌ | ✔ | ✔ | ||
| Get Account Transactions | /accounts/{AccountId}/transactions | API available | ✔ | ✔ | ✔ | ✔ |
| Pending authorisations | ❌ | ❌ | ✔ | ✔ | ||
| Unique immutable transaction IDs | ❌ | ❌ | ✔ | ✔ | ||
| Get Account Statements | /accounts/{AccountId}/statements | API available(for Credit Cards) | ❌ | ❌ | ✔ | ✔ |
| Pending authorisations | ❌ | ❌ | ✔ | ✔ | ||
| Unique immutable statement IDs | ❌ | ❌ | ❌ | ❌ | ||
| Get Account Beneficiaries | /accounts/{AccountId}/beneficiaries | API available | ✔ | ✔ | ✔ | ✔ |
| Get Account Balances | /accounts/{AccountId}/balances | API available | ✔ | ✔ | ✔ | ✔ |
| Overdraft information | ❌ | ❌ | ✔ | ✔ | ||
| Get Account Direct Debits | /accounts/{AccountId}/direct-debits | API available | ✔ | ✔ | ✔ | ✔ |
| SEPA Direct Debits (only available for Bankline customers) | ❌ | ❌ | ✔ | ✔ | ||
| Get Account Standing Orders | /accounts/{AccountId}/standing-orders | API available | ✔ | ✔ | ✔ | ✔ |
| Get Account Product | /accounts/{AccountId}/product | API available | ✔ | ✔ | ✔ | ✔ |
| Get Account Scheduled Payments | /accounts/{AccountId}/scheduled-payments | API available | ❌ | ❌ | ✔ | ✔ |
| Get Account Offers | /accounts/{AccountId}/offers | API available | ❌ | ❌ | ✔ | ✔ |
| Card Holder Names | /accounts/{AccountId}/card-holder-names | API available | ❌ | ❌ | ✔ | ✔ |
In-Scope Accounts Matrix
The following table shows the in-scope accounts supported for each API version:
| Account Type | v1.1 | v2.0 | v3.1 | v4.0 |
|---|---|---|---|---|
| Current Accounts* | ✔ | ✔ | ✔ | ✔ |
| Savings Accounts* | ❌ | ❌ | ✔ | ✔ |
| Credit & Charge Cards* | ❌ | ❌ | ✔ | ✔ |
| Currency Accounts* ** | ❌ | ❌ | ✔ | ✔ |
| Travel Accounts* | ❌ | ❌ | ✔ | ✔ |
*Please see the In-Scope Accounts document for a comprehensive list of supported accounts
** NatWest currency accounts use SchemeName UK.NWB.CurrencyAccount
Travel Accounts
This feature allows customers to consent to linking a Travel account and retrieving account and transaction information for that account.
Overview of the new Travel account:
- The NatWest Group current account and linked Travel account will appear to share the same Sort Code and Account Number in the API response, but the Account ID differs for the two accounts.
- Additionally, the current account is GBP denominated, while the linked Travel account is currently only available in EUR denomination. More currencies will be added in the future.
- For existing current account consents, customers need to consent to the new linked Travel account for this account to be included in the responses provided by our Account & Transaction API.
- Funds can only be added to travel accounts from the linked current account.
To learn more about our new Travel account, click here: What is a Travel account?
Account and Transaction API Specification
v4.0.0
OAS 3.0
Swagger for Account and Transaction API Specification
Account Access
Parameters
| Name | Description |
|---|---|
|
x-fapi-auth-date
string
(header)
|
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC |
|
x-fapi-customer-ip-address
string
(header)
|
The PSU's IP address if the PSU is currently logged in with the TPP. |
|
x-fapi-interaction-id
string
(header)
|
An RFC4122 UID used as a correlation id. |
|
Authorization
*
string
(header)
|
An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
|
x-customer-user-agent
string
(header)
|
Indicates the user-agent that the PSU is using. |
Request body
Default
{
"Data": {
"Permissions": [
"ReadAccountsBasic"
],
"ExpirationDateTime": "2025-06-13T12:03:29.688Z",
"TransactionFromDateTime": "2025-06-13T12:03:29.688Z",
"TransactionToDateTime": "2025-06-13T12:03:29.688Z"
},
"Risk": {}
}
Responses
| Code | Description | Links | |||||||||
| 201 |
Account Access Consents Created
Media type
Accept
header.
Headers:
|
No links | |||||||||
| 400 |
Bad request
Media type
Headers:
|
No links | |||||||||
| 401 |
Unauthorized Headers:
|
No links | |||||||||
| 403 |
Forbidden
Media type
Headers:
|
No links | |||||||||
| 405 |
Method Not Allowed Headers:
|
No links | |||||||||
| 406 |
Not Acceptable Headers:
|
No links | |||||||||
| 415 |
Unsupported Media Type Headers:
|
No links | |||||||||
| 429 |
Too Many Requests Headers:
|
No links | |||||||||
| 500 |
Internal Server Error
Media type
Headers:
|
No links |
Parameters
| Name | Description |
|---|---|
|
ConsentId
*
string
(path)
|
ConsentId |
|
x-fapi-auth-date
string
(header)
|
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC |
|
x-fapi-customer-ip-address
string
(header)
|
The PSU's IP address if the PSU is currently logged in with the TPP. |
|
x-fapi-interaction-id
string
(header)
|
An RFC4122 UID used as a correlation id. |
|
Authorization
*
string
(header)
|
An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
|
x-customer-user-agent
string
(header)
|
Indicates the user-agent that the PSU is using. |
Responses
| Code | Description | Links | |||||||||
| 200 |
Account Access Consents Read
Media type
Accept
header.
Headers:
|
No links | |||||||||
| 400 |
Bad request
Media type
Headers:
|
No links | |||||||||
| 401 |
Unauthorized Headers:
|
No links | |||||||||
| 403 |
Forbidden
Media type
Headers:
|
No links | |||||||||
| 405 |
Method Not Allowed Headers:
|
No links | |||||||||
| 406 |
Not Acceptable Headers:
|
No links | |||||||||
| 429 |
Too Many Requests Headers:
|
No links | |||||||||
| 500 |
Internal Server Error
Media type
Headers:
|
No links |
Parameters
| Name | Description |
|---|---|
|
ConsentId
*
string
(path)
|
ConsentId |
|
x-fapi-auth-date
string
(header)
|
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC |
|
x-fapi-customer-ip-address
string
(header)
|
The PSU's IP address if the PSU is currently logged in with the TPP. |
|
x-fapi-interaction-id
string
(header)
|
An RFC4122 UID used as a correlation id. |
|
Authorization
*
string
(header)
|
An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
|
x-customer-user-agent
string
(header)
|
Indicates the user-agent that the PSU is using. |
Responses
| Code | Description | Links | |||||||||
| 204 |
Account Access Consents Deleted Headers:
|
No links | |||||||||
| 400 |
Bad request
Media type
Headers:
|
No links | |||||||||
| 401 |
Unauthorized Headers:
|
No links | |||||||||
| 403 |
Forbidden
Media type
Headers:
|
No links | |||||||||
| 405 |
Method Not Allowed Headers:
|
No links | |||||||||
| 406 |
Not Acceptable Headers:
|
No links | |||||||||
| 429 |
Too Many Requests Headers:
|
No links | |||||||||
| 500 |
Internal Server Error
Media type
Headers:
|
No links |
Accounts
Parameters
| Name | Description |
|---|---|
|
x-fapi-auth-date
string
(header)
|
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC |
|
x-fapi-customer-ip-address
string
(header)
|
The PSU's IP address if the PSU is currently logged in with the TPP. |
|
x-fapi-interaction-id
string
(header)
|
An RFC4122 UID used as a correlation id. |
|
Authorization
*
string
(header)
|
An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
|
x-customer-user-agent
string
(header)
|
Indicates the user-agent that the PSU is using. |
Responses
| Code | Description | Links | |||||||||
| 200 |
Accounts Read
Media type
Accept
header.
Headers:
|
No links | |||||||||
| 400 |
Bad request
Media type
Headers:
|
No links | |||||||||
| 401 |
Unauthorized Headers:
|
No links | |||||||||
| 403 |
Forbidden
Media type
Headers:
|
No links | |||||||||
| 405 |
Method Not Allowed Headers:
|
No links | |||||||||
| 406 |
Not Acceptable Headers:
|
No links | |||||||||
| 429 |
Too Many Requests Headers:
|
No links | |||||||||
| 500 |
Internal Server Error
Media type
Headers:
|
No links |
Parameters
| Name | Description |
|---|---|
|
AccountId
*
string
(path)
|
AccountId |
|
x-fapi-auth-date
string
(header)
|
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC |
|
x-fapi-customer-ip-address
string
(header)
|
The PSU's IP address if the PSU is currently logged in with the TPP. |
|
x-fapi-interaction-id
string
(header)
|
An RFC4122 UID used as a correlation id. |
|
Authorization
*
string
(header)
|
An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
|
x-customer-user-agent
string
(header)
|
Indicates the user-agent that the PSU is using. |
Responses
| Code | Description | Links | |||||||||
| 200 |
Accounts Read
Media type
Accept
header.
Headers:
|
No links | |||||||||
| 400 |
Bad request
Media type
Headers:
|
No links | |||||||||
| 401 |
Unauthorized Headers:
|
No links | |||||||||
| 403 |
Forbidden
Media type
Headers:
|
No links | |||||||||
| 405 |
Method Not Allowed Headers:
|
No links | |||||||||
| 406 |
Not Acceptable Headers:
|
No links | |||||||||
| 429 |
Too Many Requests Headers:
|
No links | |||||||||
| 500 |
Internal Server Error
Media type
Headers:
|
No links |
Cards API is related to an account. See the card holder names Endpoint section for more detail.
Parameters
| Name | Description |
|---|---|
|
AccountId
*
(path)
|
A unique identifier used to identify the account resource. |
|
x-fapi-financial-id
*
(header)
|
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB. The value for NatWest is 0015800000jfwxXAAQ. |
|
x-fapi-auth-date
(header)
|
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC |
|
x-fapi-customer-ip-address
(header)
|
The PSU's IP address if the PSU is currently logged in with the TPP. |
|
x-fapi-interaction-id
(header)
|
An RFC4122 UID used as a correlation id. |
|
Authorization
*
(header)
|
An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
Responses
| Code | Description | Links | |||||||||
| 200 |
Cards details successfully retrieved
Media type
Accept
header.
Headers:
|
No links | |||||||||
| 400 |
Bad request
Media type
Headers:
|
No links | |||||||||
| 401 |
Unauthorized Headers:
|
No links | |||||||||
| 403 |
Forbidden
Media type
Headers:
|
No links | |||||||||
| 405 |
Method Not Allowed Headers:
|
No links | |||||||||
| 406 |
Not Acceptable Headers:
|
No links | |||||||||
| 429 |
Too Many Requests Headers:
|
No links | |||||||||
| 500 |
Internal Server Error
Media type
Headers:
|
No links |
Balances
Parameters
| Name | Description |
|---|---|
|
AccountId
*
string
(path)
|
AccountId |
|
x-fapi-auth-date
string
(header)
|
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC |
|
x-fapi-customer-ip-address
string
(header)
|
The PSU's IP address if the PSU is currently logged in with the TPP. |
|
x-fapi-interaction-id
string
(header)
|
An RFC4122 UID used as a correlation id. |
|
Authorization
*
string
(header)
|
An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
|
x-customer-user-agent
string
(header)
|
Indicates the user-agent that the PSU is using. |
Responses
| Code | Description | Links | |||||||||
| 200 |
Balances Read
Media type
Accept
header.
Headers:
|
No links | |||||||||
| 400 |
Bad request
Media type
Headers:
|
No links | |||||||||
| 401 |
Unauthorized Headers:
|
No links | |||||||||
| 403 |
Forbidden
Media type
Headers:
|
No links | |||||||||
| 405 |
Method Not Allowed Headers:
|
No links | |||||||||
| 406 |
Not Acceptable Headers:
|
No links | |||||||||
| 429 |
Too Many Requests Headers:
|
No links | |||||||||
| 500 |
Internal Server Error
Media type
Headers:
|
No links |
Beneficiaries
Parameters
| Name | Description |
|---|---|
|
AccountId
*
string
(path)
|
AccountId |
|
x-fapi-auth-date
string
(header)
|
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC |
|
x-fapi-customer-ip-address
string
(header)
|
The PSU's IP address if the PSU is currently logged in with the TPP. |
|
x-fapi-interaction-id
string
(header)
|
An RFC4122 UID used as a correlation id. |
|
Authorization
*
string
(header)
|
An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
|
x-customer-user-agent
string
(header)
|
Indicates the user-agent that the PSU is using. |
Responses
| Code | Description | Links | |||||||||
| 200 |
Beneficiaries Read
Media type
Accept
header.
Headers:
|
No links | |||||||||
| 400 |
Bad request
Media type
Headers:
|
No links | |||||||||
| 401 |
Unauthorized Headers:
|
No links | |||||||||
| 403 |
Forbidden
Media type
Headers:
|
No links | |||||||||
| 404 |
Not found Headers:
|
No links | |||||||||
| 405 |
Method Not Allowed Headers:
|
No links | |||||||||
| 406 |
Not Acceptable Headers:
|
No links | |||||||||
| 429 |
Too Many Requests Headers:
|
No links | |||||||||
| 500 |
Internal Server Error
Media type
Headers:
|
No links |
Direct Debits
Parameters
| Name | Description |
|---|---|
|
AccountId
*
string
(path)
|
AccountId |
|
x-fapi-auth-date
string
(header)
|
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC |
|
x-fapi-customer-ip-address
string
(header)
|
The PSU's IP address if the PSU is currently logged in with the TPP. |
|
x-fapi-interaction-id
string
(header)
|
An RFC4122 UID used as a correlation id. |
|
Authorization
*
string
(header)
|
An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
|
x-customer-user-agent
string
(header)
|
Indicates the user-agent that the PSU is using. |
Responses
| Code | Description | Links | |||||||||
| 200 |
Direct Debits Read
Media type
Accept
header.
Headers:
|
No links | |||||||||
| 400 |
Bad request
Media type
Headers:
|
No links | |||||||||
| 401 |
Unauthorized Headers:
|
No links | |||||||||
| 403 |
Forbidden
Media type
Headers:
|
No links | |||||||||
| 404 |
Not found Headers:
|
No links | |||||||||
| 405 |
Method Not Allowed Headers:
|
No links | |||||||||
| 406 |
Not Acceptable Headers:
|
No links | |||||||||
| 429 |
Too Many Requests Headers:
|
No links | |||||||||
| 500 |
Internal Server Error
Media type
Headers:
|
No links |
Offers
Parameters
| Name | Description |
|---|---|
|
AccountId
*
string
(path)
|
AccountId |
|
x-fapi-auth-date
string
(header)
|
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC |
|
x-fapi-customer-ip-address
string
(header)
|
The PSU's IP address if the PSU is currently logged in with the TPP. |
|
x-fapi-interaction-id
string
(header)
|
An RFC4122 UID used as a correlation id. |
|
Authorization
*
string
(header)
|
An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
|
x-customer-user-agent
string
(header)
|
Indicates the user-agent that the PSU is using. |
Responses
| Code | Description | Links | |||||||||
| 200 |
Offers Read
Media type
Accept
header.
Headers:
|
No links | |||||||||
| 400 |
Bad request
Media type
Headers:
|
No links | |||||||||
| 401 |
Unauthorized Headers:
|
No links | |||||||||
| 403 |
Forbidden
Media type
Headers:
|
No links | |||||||||
| 404 |
Not found Headers:
|
No links | |||||||||
| 405 |
Method Not Allowed Headers:
|
No links | |||||||||
| 406 |
Not Acceptable Headers:
|
No links | |||||||||
| 429 |
Too Many Requests Headers:
|
No links | |||||||||
| 500 |
Internal Server Error
Media type
Headers:
|
No links |
Products
Parameters
| Name | Description |
|---|---|
|
AccountId
*
string
(path)
|
AccountId |
|
x-fapi-auth-date
string
(header)
|
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC |
|
x-fapi-customer-ip-address
string
(header)
|
The PSU's IP address if the PSU is currently logged in with the TPP. |
|
x-fapi-interaction-id
string
(header)
|
An RFC4122 UID used as a correlation id. |
|
Authorization
*
string
(header)
|
An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
|
x-customer-user-agent
string
(header)
|
Indicates the user-agent that the PSU is using. |
Responses
| Code | Description | Links | |||||||||
| 200 |
Products Read
Media type
Accept
header.
Headers:
|
No links | |||||||||
| 400 |
Bad request
Media type
Headers:
|
No links | |||||||||
| 401 |
Unauthorized Headers:
|
No links | |||||||||
| 403 |
Forbidden
Media type
Headers:
|
No links | |||||||||
| 404 |
Not found Headers:
|
No links | |||||||||
| 405 |
Method Not Allowed Headers:
|
No links | |||||||||
| 406 |
Not Acceptable Headers:
|
No links | |||||||||
| 429 |
Too Many Requests Headers:
|
No links | |||||||||
| 500 |
Internal Server Error
Media type
Headers:
|
No links |
Scheduled Payments
Parameters
| Name | Description |
|---|---|
|
AccountId
*
string
(path)
|
AccountId |
|
x-fapi-auth-date
string
(header)
|
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC |
|
x-fapi-customer-ip-address
string
(header)
|
The PSU's IP address if the PSU is currently logged in with the TPP. |
|
x-fapi-interaction-id
string
(header)
|
An RFC4122 UID used as a correlation id. |
|
Authorization
*
string
(header)
|
An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
|
x-customer-user-agent
string
(header)
|
Indicates the user-agent that the PSU is using. |
Responses
| Code | Description | Links | |||||||||
| 200 |
Scheduled Payments Read
Media type
Accept
header.
Headers:
|
No links | |||||||||
| 400 |
Bad request
Media type
Headers:
|
No links | |||||||||
| 401 |
Unauthorized Headers:
|
No links | |||||||||
| 403 |
Forbidden
Media type
Headers:
|
No links | |||||||||
| 404 |
Not found Headers:
|
No links | |||||||||
| 405 |
Method Not Allowed Headers:
|
No links | |||||||||
| 406 |
Not Acceptable Headers:
|
No links | |||||||||
| 429 |
Too Many Requests Headers:
|
No links | |||||||||
| 500 |
Internal Server Error
Media type
Headers:
|
No links |
Standing Orders
Parameters
| Name | Description |
|---|---|
|
AccountId
*
string
(path)
|
AccountId |
|
x-fapi-auth-date
string
(header)
|
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC |
|
x-fapi-customer-ip-address
string
(header)
|
The PSU's IP address if the PSU is currently logged in with the TPP. |
|
x-fapi-interaction-id
string
(header)
|
An RFC4122 UID used as a correlation id. |
|
Authorization
*
string
(header)
|
An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
|
x-customer-user-agent
string
(header)
|
Indicates the user-agent that the PSU is using. |
Responses
| Code | Description | Links | |||||||||
| 200 |
Standing Orders Read
Media type
Accept
header.
Headers:
|
No links | |||||||||
| 400 |
Bad request
Media type
Headers:
|
No links | |||||||||
| 401 |
Unauthorized Headers:
|
No links | |||||||||
| 403 |
Forbidden
Media type
Headers:
|
No links | |||||||||
| 404 |
Not found Headers:
|
No links | |||||||||
| 405 |
Method Not Allowed Headers:
|
No links | |||||||||
| 406 |
Not Acceptable Headers:
|
No links | |||||||||
| 429 |
Too Many Requests Headers:
|
No links | |||||||||
| 500 |
Internal Server Error
Media type
Headers:
|
No links |
Statements
Parameters
| Name | Description |
|---|---|
|
AccountId
*
string
(path)
|
AccountId |
|
x-fapi-auth-date
string
(header)
|
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC |
|
x-fapi-customer-ip-address
string
(header)
|
The PSU's IP address if the PSU is currently logged in with the TPP. |
|
x-fapi-interaction-id
string
(header)
|
An RFC4122 UID used as a correlation id. |
|
Authorization
*
string
(header)
|
An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
|
x-customer-user-agent
string
(header)
|
Indicates the user-agent that the PSU is using. |
|
fromStatementDateTime
string
($date-time)
(query)
|
The UTC ISO 8601 Date Time to filter statements FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component. |
|
toStatementDateTime
string
($date-time)
(query)
|
The UTC ISO 8601 Date Time to filter statements TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component. |
Responses
| Code | Description | Links | |||||||||
| 200 |
Statements Read
Media type
Accept
header.
Headers:
|
No links | |||||||||
| 400 |
Bad request
Media type
Headers:
|
No links | |||||||||
| 401 |
Unauthorized Headers:
|
No links | |||||||||
| 403 |
Forbidden
Media type
Headers:
|
No links | |||||||||
| 404 |
Not found Headers:
|
No links | |||||||||
| 405 |
Method Not Allowed Headers:
|
No links | |||||||||
| 406 |
Not Acceptable Headers:
|
No links | |||||||||
| 429 |
Too Many Requests Headers:
|
No links | |||||||||
| 500 |
Internal Server Error
Media type
Headers:
|
No links |
Transactions
Parameters
| Name | Description |
|---|---|
|
AccountId
*
string
(path)
|
AccountId |
|
x-fapi-auth-date
string
(header)
|
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC |
|
x-fapi-customer-ip-address
string
(header)
|
The PSU's IP address if the PSU is currently logged in with the TPP. |
|
x-fapi-interaction-id
string
(header)
|
An RFC4122 UID used as a correlation id. |
|
Authorization
*
string
(header)
|
An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
|
x-customer-user-agent
string
(header)
|
Indicates the user-agent that the PSU is using. |
|
fromBookingDateTime
string
($date-time)
(query)
|
The UTC ISO 8601 Date Time to filter transactions FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component. |
|
toBookingDateTime
string
($date-time)
(query)
|
The UTC ISO 8601 Date Time to filter transactions TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component. |
Responses
| Code | Description | Links | |||||||||
| 200 |
Transactions Read
Media type
Accept
header.
Headers:
|
No links | |||||||||
| 400 |
Bad request
Media type
Headers:
|
No links | |||||||||
| 401 |
Unauthorized Headers:
|
No links | |||||||||
| 403 |
Forbidden
Media type
Headers:
|
No links | |||||||||
| 405 |
Method Not Allowed Headers:
|
No links | |||||||||
| 406 |
Not Acceptable Headers:
|
No links | |||||||||
| 429 |
Too Many Requests Headers:
|
No links | |||||||||
| 500 |
Internal Server Error
Media type
Headers:
|
No links |
-
string
Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see
ExternalCreditorReferenceType1Codein ISO_External_CodeSet hereENUM: DISP, FXDR, PUOR, RPIN, RADM, SCOR
- minLength 1
- maxLength 4
-
string
Specifies the document type as published in an external document type code list. For more information see
ExternalDocumentType1Codein ISO_External_CodeSet hereENUM: CINV, CNFA, CONT, CREN, DEBN, DISP, DNFA, HIRI, INVS, MSIN, PROF, PUOR, QUOT, SBIN, SPRR, TISH
- minLength 1
- maxLength 4
-
{
}-
Code string
Specifies the document type as published in an external document type code list. For more information see
ExternalDocumentType1Codein ISO_External_CodeSet hereENUM: CINV, CNFA, CONT, CREN, DEBN, DISP, DNFA, HIRI, INVS, MSIN, PROF, PUOR, QUOT, SBIN, SPRR, TISH
- minLength 1
- maxLength 4
-
Issuer string
dentification of the issuer of the reference document type.
- maxLength 140
- minLength 1
-
Number string
Identification of the type specified for the referred document line.
- maxLength 35
- minLength 1
-
RelatedDate string
Date associated with the referred document line.
- format date-time
-
LineDetails [
]Set of elements used to provide the content of the referred document line.
-
string
-
-
-
{
}Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system
-
Structured [
]-
OBRemittanceInformationStructured {
}-
ReferredDocumentInformation [
]-
OBReferredDocumentInformation {
}-
Code string
Specifies the document type as published in an external document type code list. For more information see
ExternalDocumentType1Codein ISO_External_CodeSet hereENUM: CINV, CNFA, CONT, CREN, DEBN, DISP, DNFA, HIRI, INVS, MSIN, PROF, PUOR, QUOT, SBIN, SPRR, TISH
- minLength 1
- maxLength 4
-
Issuer string
dentification of the issuer of the reference document type.
- maxLength 140
- minLength 1
-
Number string
Identification of the type specified for the referred document line.
- maxLength 35
- minLength 1
-
RelatedDate string
Date associated with the referred document line.
- format date-time
-
LineDetails [
]Set of elements used to provide the content of the referred document line.
-
string
-
-
-
-
ReferredDocumentAmount integer
Provides details on the amounts of the referred document.
- format int32
-
CreditorReferenceInformation {
}Reference information provided by the creditor to allow the identification of the underlying documents.
-
Code string
Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see
ExternalCreditorReferenceType1Codein ISO_External_CodeSet hereENUM: DISP, FXDR, PUOR, RPIN, RADM, SCOR
- minLength 1
- maxLength 4
-
Issuer string
Entity that assigns the identification.
- minLength 1
- maxLength 35
-
Reference string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
- minLength 1
- maxLength 35
-
-
Invoicer string
Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Invoicee string
dentification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
TaxRemittance string
Provides remittance information about a payment made for tax-related purposes.
- maxLength 140
- minLength 1
-
AdditionalRemittanceInformation [
]Additional information, in free text form, to complement the structured remittance information.
- maxItems 3
-
string
- maxLength 140
- minLength 1
-
-
-
Unstructured [
]Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
-
string
- maxLength 140
- minLength 1
-
-
-
{
}-
ReferredDocumentInformation [
]-
OBReferredDocumentInformation {
}-
Code string
Specifies the document type as published in an external document type code list. For more information see
ExternalDocumentType1Codein ISO_External_CodeSet hereENUM: CINV, CNFA, CONT, CREN, DEBN, DISP, DNFA, HIRI, INVS, MSIN, PROF, PUOR, QUOT, SBIN, SPRR, TISH
- minLength 1
- maxLength 4
-
Issuer string
dentification of the issuer of the reference document type.
- maxLength 140
- minLength 1
-
Number string
Identification of the type specified for the referred document line.
- maxLength 35
- minLength 1
-
RelatedDate string
Date associated with the referred document line.
- format date-time
-
LineDetails [
]Set of elements used to provide the content of the referred document line.
-
string
-
-
-
-
ReferredDocumentAmount integer
Provides details on the amounts of the referred document.
- format int32
-
CreditorReferenceInformation {
}Reference information provided by the creditor to allow the identification of the underlying documents.
-
Code string
Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see
ExternalCreditorReferenceType1Codein ISO_External_CodeSet hereENUM: DISP, FXDR, PUOR, RPIN, RADM, SCOR
- minLength 1
- maxLength 4
-
Issuer string
Entity that assigns the identification.
- minLength 1
- maxLength 35
-
Reference string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
- minLength 1
- maxLength 35
-
-
Invoicer string
Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Invoicee string
dentification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
TaxRemittance string
Provides remittance information about a payment made for tax-related purposes.
- maxLength 140
- minLength 1
-
AdditionalRemittanceInformation [
]Additional information, in free text form, to complement the structured remittance information.
- maxItems 3
-
string
- maxLength 140
- minLength 1
-
-
{
}Ultimate party to which an amount of money is due.
-
Name string
Name by which a party is known and which is usually used to identify that party.
- minLength 1
- maxLength 140
-
Identification string
Identification assigned by an institution.
- minLength 1
- maxLength 256
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
{
}Ultimate party that owes an amount of money to the (ultimate) creditor.
-
Name string
Name by which a party is known and which is usually used to identify that party.
- minLength 1
- maxLength 140
-
Identification string
Identification assigned by an institution.
- minLength 1
- maxLength 256
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
{
}Regularity with which credit transfer instructions are to be created and processed
-
Type string
For a full list of values see
OBFrequency6Codein OB_Internal_CodeSet hereENUM: YEAR, FRTN, MNTH, QURT, MIAN, WEEK, FOWK, TWMH, FOMH
EXAMPLE: MNTH -
PointInTime string
Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or moment within a specified frequency type. Note: should not be used alongside
CountPerPeriod.EXAMPLE: 01- maxLength 2
-
-
{
}Regularity with which credit transfer instructions are to be created and processed
-
Type string
For a full list of values see
OBFrequency6Codein OB_Internal_CodeSet hereENUM: YEAR, FRTN, MNTH, QURT, MIAN, WEEK, FOWK, TWMH, FOMH
EXAMPLE: MNTH
-
-
string
Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or moment within a specified frequency type. Note: should not be used alongside
CountPerPeriod.EXAMPLE: 01- maxLength 2
-
string
For a full list of values see
OBFrequency6Codein OB_Internal_CodeSet hereENUM: YEAR, FRTN, MNTH, QURT, MIAN, WEEK, FOWK, TWMH, FOMH
EXAMPLE: MNTH
-
{
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE
-
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
string
Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
- pattern ^[A-Z]{3,3}$
-
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
- minLength 1
- maxLength 70
-
string
A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
EXAMPLE: Ben1- minLength 1
- maxLength 40
-
string
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
string
Name of a referenced building.
- minLength 1
- maxLength 140
-
string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
string
Nation with its own government, occupying a particular territory.
- pattern ^[A-Z]{2,2}$
-
string
Identifies a subdivision of a country eg, state, region, county.
- minLength 1
- maxLength 35
-
string
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2024-05-29T00:00:00Z- format date-time
-
string
Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date format. An example is below: 2017-04-05
- format date
-
string
Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2024-05-29T00:00:00Z- format date-time
-
string
A reference value provided by the PSU to the PISP while setting up the scheduled payment.
EXAMPLE: REF51561806- minLength 1
- maxLength 35
-
string
Specifies the description of the account type.
- minLength 1
- maxLength 35
-
string
Description that may be available for the statement fee.
EXAMPLE: International usage charge- minLength 1
- maxLength 128
-
string
Description that may be available for the statement interest.
EXAMPLE: Interest occurred over statement duration- minLength 1
- maxLength 128
-
string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
string
A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.
- minLength 1
- maxLength 40
-
string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
string
Address for electronic mail (e-mail).
EXAMPLE: d.user@semiotec.co.jp- minLength 1
- maxLength 256
-
string
Date and time at which the statement period ends. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
{
}
-
string
The date on which the final payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
string
The date on which the first payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
string
Individual Definitions: NotKnown - Not Known EvryDay - Every day EvryWorkgDay - Every working day IntrvlDay - An interval specified in number of calendar days (02 to 31) IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-05 to -01, 01 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED) ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: NotKnown (ScheduleCode) EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlDay:NoOfDay (ScheduleCode + NoOfDay) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: NotKnown EvryDay EvryWorkgDay IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]) IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) QtrDay:(ENGLISH|SCOTTISH|RECEIVED) Full Regular Expression: ^(NotKnown)$|^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
- pattern ^(NotKnown)$|^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
-
string
The full legal name of the party.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
- minLength 1
- maxLength 35
-
string
Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
string
dentification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
string
The date on which the last (most recent) payment for a Standing Order schedule was made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
{
}Links relevant to the payload
-
Self string
- format uri
-
First string
- format uri
-
Prev string
- format uri
-
Next string
- format uri
-
Last string
- format uri
-
-
string
Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.
- minLength 1
- maxLength 35
-
string
Maturity date of the account. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
MetaData {
}Meta Data relevant to the payload
-
TotalPages integer
- format int32
-
FirstAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
LastAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
string
Name of Service User.
- minLength 1
- maxLength 70
-
string
Name by which a party is known and which is usually used to identify that party.
EXAMPLE: Mx Jane Smith- minLength 1
- maxLength 350
-
string
Long name associated with the code
- minLength 1
- maxLength 70
-
string
The date on which the next payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
string
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
- minLength 1
- maxLength 70
-
string
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
- minLength 1
- maxLength 35
-
integer
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it s part of a government scheme, or whether the rate may vary dependent on the applicant s circumstances.
-
integer
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
-
{
}Unambiguous identification of the account to which credit and debit entries are made. The following fields are optional only for accounts that are switched:
- Data.Currency
- Data.AccountCategory
- Data.AccountTypeCode
For all other accounts, the fields must be populated by the ASPSP.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
Status string
Specifies the status of account resource in code form.
For a full list of enumeration values refer toOBInternalAccountStatus1Codein OB_Internal_CodeSet hereENUM: Deleted, Disabled, Enabled, Pending, ProForma
EXAMPLE: Enabled -
StatusUpdateDateTime string
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
Currency string
Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
- pattern ^[A-Z]{3,3}$
-
AccountCategory string
Specifies the type of account (personal or business).
For a full list of enumeration values refer to 'OBInternalAccountType1Code' in OB_Internal_CodeSet hereENUM: Business, Personal
-
AccountTypeCode string
Specifies the sub type of account (product family group)
For a full list of enumeration values refer toOBExternalCashAccountType1CodeOB_Internal_CodeSet hereENUM: CACC, CARD, CASH, CHAR, CISH, COMM, CPAC, LLSV, LOAN, MGLD, MOMA, NREX, ODFT, ONDP, OTHR, SACC, SLRY, SVGS, TAXE, TRAN, TRAS, VACC, NFCA, MORT, WALT
-
Description string
Specifies the description of the account type.
- minLength 1
- maxLength 35
-
Nickname string
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
- minLength 1
- maxLength 70
-
OpeningDate string
Date on which the account and related basic services are effectively operational for the account owner. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
MaturityDate string
Maturity date of the account. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
SwitchStatus string
Specifies the switch status for the account, in a coded form.
For a full list of enumeration values refer toOBInternalSwitchStatusCodein OB_Internal_CodeSet here- x-namespaced-enum UK.CASS.NotSwitched,UK.CASS.SwitchCompleted
-
Account [
]-
{
}Provides the details to identify an account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
-
-
StatementFrequencyAndFormat [
]-
{
}Frequency and format of statments for an account
-
Frequency string
For a full list of enumeration values refer to
OBFrequency2Codein OB_Internal_CodeSet hereENUM: YEAR, DAIL, INDA, MNTH, QURT, MIAN, TEND, MOVE, WEEK
-
CommunicationMethod string
For a full list of enumeration values see
OBExternalCommunicationMethod2Codein OB_Internal_CodeSet hereENUM: EMAL, FAXI, FILE, ONLI, POST
-
Format string
For a full list of enumeration values refer to
ExternalDocumentFormat1Codein OB_Internal_CodeSet hereENUM: DPDF, DXML, SDSH, WORD, XSLT
-
DeliveryAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
-
Servicer {
}Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
-
{
}Unambiguous identification of the account to which credit and debit entries are made.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
Status string
Specifies the status of account resource in code form.
For a full list of enumeration values refer toOBInternalAccountStatus1Codein OB_Internal_CodeSet hereENUM: Deleted, Disabled, Enabled, Pending, ProForma
EXAMPLE: Enabled -
StatusUpdateDateTime string
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
Currency string
Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
- pattern ^[A-Z]{3,3}$
-
AccountCategory string
Specifies the type of account (personal or business).
For a full list of enumeration values refer to 'OBInternalAccountType1Code' in OB_Internal_CodeSet hereENUM: Business, Personal
-
AccountTypeCode string
Specifies the sub type of account (product family group)
For a full list of enumeration values refer toOBExternalCashAccountType1CodeOB_Internal_CodeSet hereENUM: CACC, CARD, CASH, CHAR, CISH, COMM, CPAC, LLSV, LOAN, MGLD, MOMA, NREX, ODFT, ONDP, OTHR, SACC, SLRY, SVGS, TAXE, TRAN, TRAS, VACC, NFCA, MORT, WALT
-
Description string
Specifies the description of the account type.
- minLength 1
- maxLength 35
-
Nickname string
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
- minLength 1
- maxLength 70
-
OpeningDate string
Date on which the account and related basic services are effectively operational for the account owner. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
MaturityDate string
Maturity date of the account. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
SwitchStatus string
Specifies the switch status for the account, in a coded form.
For a full list of enumeration values refer toOBInternalSwitchStatusCodein OB_Internal_CodeSet here- x-namespaced-enum UK.CASS.NotSwitched,UK.CASS.SwitchCompleted
-
-
{
}Unambiguous identification of the account to which credit and debit entries are made.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
Status string
Specifies the status of account resource in code form.
For a full list of enumeration values refer toOBInternalAccountStatus1Codein OB_Internal_CodeSet hereENUM: Deleted, Disabled, Enabled, Pending, ProForma
EXAMPLE: Enabled -
StatusUpdateDateTime string
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
Currency string
Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
- pattern ^[A-Z]{3,3}$
-
AccountCategory string
Specifies the type of account (personal or business).
For a full list of enumeration values refer to 'OBInternalAccountType1Code' in OB_Internal_CodeSet hereENUM: Business, Personal
-
AccountTypeCode string
Specifies the sub type of account (product family group)
For a full list of enumeration values refer toOBExternalCashAccountType1CodeOB_Internal_CodeSet hereENUM: CACC, CARD, CASH, CHAR, CISH, COMM, CPAC, LLSV, LOAN, MGLD, MOMA, NREX, ODFT, ONDP, OTHR, SACC, SLRY, SVGS, TAXE, TRAN, TRAS, VACC, NFCA, MORT, WALT
-
Description string
Specifies the description of the account type.
- minLength 1
- maxLength 35
-
Nickname string
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
- minLength 1
- maxLength 70
-
OpeningDate string
Date on which the account and related basic services are effectively operational for the account owner. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
MaturityDate string
Maturity date of the account. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
SwitchStatus string
Specifies the switch status for the account, in a coded form.
For a full list of enumeration values refer toOBInternalSwitchStatusCodein OB_Internal_CodeSet here- x-namespaced-enum UK.CASS.NotSwitched,UK.CASS.SwitchCompleted
-
Account [
]-
{
}Provides the details to identify an account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
-
-
StatementFrequencyAndFormat [
]-
{
}Frequency and format of statments for an account
-
Frequency string
For a full list of enumeration values refer to
OBFrequency2Codein OB_Internal_CodeSet hereENUM: YEAR, DAIL, INDA, MNTH, QURT, MIAN, TEND, MOVE, WEEK
-
CommunicationMethod string
For a full list of enumeration values see
OBExternalCommunicationMethod2Codein OB_Internal_CodeSet hereENUM: EMAL, FAXI, FILE, ONLI, POST
-
Format string
For a full list of enumeration values refer to
ExternalDocumentFormat1Codein OB_Internal_CodeSet hereENUM: DPDF, DXML, SDSH, WORD, XSLT
-
DeliveryAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
-
Servicer {
}Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
-
-
string
Specifies the status of account resource in code form.
For a full list of enumeration values refer toOBInternalAccountStatus1Codein OB_Internal_CodeSet hereENUM: Deleted, Disabled, Enabled, Pending, ProForma
EXAMPLE: Enabled
-
string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
{
}The amount of the most recent direct debit collection.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
{
}Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
{
}Transaction charges to be paid by the charge bearer.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
{
}The amount of the last (most recent) Standing Order instruction.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
{
}The amount of the first Standing Order
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
{
}The amount of the next Standing Order.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
{
}The amount of the final Standing Order
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
{
}Amount of money associated with the statement benefit type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
{
}Amount of money associated with the statement fee type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
{
}Amount of money associated with the statement interest amount type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
{
}Amount of money associated with the amount type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
SubType string
Amount sub type, in a coded form. Default if not specified is BCUR of the account.
ENUM: BCUR, LCUR
-
-
{
}Amount of money in the cash transaction entry.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
string
Identifies the nature of the postal address.
ENUM: Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement
-
string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ
-
BCA {
}-
ProductDetails ProductDetails {
}-
Segment Segment [
]Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to BCA products, they are segmented in relation to different markets that they wish to focus on.
-
string
Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to BCA products, they are segmented in relation to different markets that they wish to focus on.
ENUM: ClientAccount, Standard, NonCommercialChaitiesClbSoc, NonCommercialPublicAuthGovt, Religious, SectorSpecific, Startup, Switcher
-
-
FeeFreeLength FeeFreeLength number
The length/duration of the fee free period
- format float
-
FeeFreeLengthPeriod FeeFreeLengthPeriod string
The unit of period (days, weeks, months etc.) of the promotional length
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Optional additional notes to supplement the Core product details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
-
CreditInterest CreditInterest {
}Details about the interest that may be payable to the BCA account holders
-
TierBandSet TierBandSet [
]The group of tiers or bands for which credit interest can be applied.
- minItems 1
-
{
}The group of tiers or bands for which credit interest can be applied.
-
TierBandMethod TierBandMethod string
The methodology of how credit interest is paid/applied. It can be:-
-
Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases.
-
Tiered Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance.
-
Whole The same interest rate is applied irrespective of the BCA balance
ENUM: Banded, Tiered, Whole
-
-
CalculationMethod CalculationMethod string
Methods of calculating interest
ENUM: Compound, SimpleInterest
-
Destination Destination string
Describes whether accrued interest is payable only to the BCA or to another bank account
ENUM: PayAway, SelfCredit
-
Notes Notes [
]Optional additional notes to supplement the Tier Band Set details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
TierBand TierBand [
]Tier Band Details
- minItems 1
-
{
}Tier Band Details
-
Identification Identification string
Unique and unambiguous identification of a Tier Band for a BCA.
- minLength 1
- maxLength 35
-
TierValueMinimum TierValueMinimum string
Minimum deposit value for which the credit interest tier applies.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
TierValueMaximum TierValueMaximum string
Maximum deposit value for which the credit interest tier applies.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CalculationFrequency CalculationFrequency string
How often is credit interest calculated for the account.
ENUM: Daily, HalfYearly, Monthly, Other, Quarterly, PerStatementDate, Weekly, Yearly
-
ApplicationFrequency ApplicationFrequency string
How often is interest applied to the BCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's BCA.
ENUM: Daily, HalfYearly, Monthly, Other, Quarterly, PerStatementDate, Weekly, Yearly
-
DepositInterestAppliedCoverage DepositInterestAppliedCoverage string
Amount on which Interest applied.
ENUM: Banded, Tiered, Whole
-
FixedVariableInterestRateType FixedVariableInterestRateType string
Type of interest rate, Fixed or Variable
ENUM: Fixed, Variable
-
AER AER string
The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
BankInterestRateType BankInterestRateType string
Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the BCA.
ENUM: Gross, Other
-
BankInterestRate BankInterestRate string
Bank Interest for the BCA product
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
Notes Notes [
]Optional additional notes to supplement the Tier Band details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherBankInterestType OtherBankInterestType {
}Other interest rate types which are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies that are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in the standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
Overdraft Overdraft {
}Borrowing details
-
Notes Notes [
]Associated Notes about the overdraft rates
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftTierBandSet OverdraftTierBandSet [
]Tier band set details
- minItems 1
-
{
}Tier band set details
-
TierBandMethod TierBandMethod string
The methodology of how overdraft is charged. It can be: 'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). 'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation 'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation.
ENUM: Banded, Tiered, Whole
-
OverdraftType OverdraftType string
An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time.
ENUM: Committed, OnDemand
-
Identification Identification string
Unique and unambiguous identification of a Tier Band for a overdraft product.
- minLength 1
- maxLength 35
-
AuthorisedIndicator AuthorisedIndicator boolean
Indicates if the Overdraft is authorised (Y) or unauthorised (N)
-
BufferAmount BufferAmount string
When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
Notes Notes [
]Optional additional notes to supplement the overdraft Tier Band Set details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftTierBand OverdraftTierBand [
]Provides overdraft details for a specific tier or band
- minItems 1
-
{
}Provides overdraft details for a specific tier or band
-
Identification Identification string
Unique and unambiguous identification of a Tier Band for a overdraft.
- minLength 1
- maxLength 35
-
TierValueMin TierValueMin string
Minimum value of Overdraft Tier/Band
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
TierValueMax TierValueMax string
Maximum value of Overdraft Tier/Band
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
EAR EAR string
EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft.
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
RepresentativeAPR RepresentativeAPR string
An annual percentage rate (APR) is the annual rate charged for borrowing or earned through an investment. APR is expressed as a percentage that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction but does not take compounding into account.
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
AgreementLengthMin AgreementLengthMin number
Specifies the minimum length of a band for a fixed overdraft agreement
- format float
-
AgreementLengthMax AgreementLengthMax number
Specifies the maximum length of a band for a fixed overdraft agreement
- format float
-
AgreementPeriod AgreementPeriod string
Specifies the period of a fixed length overdraft agreement
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
OverdraftInterestChargingCoverage OverdraftInterestChargingCoverage string
Refers to which interest rate is applied when interests are tiered. For example, if an overdraft balance is £2k and the interest tiers are:- 0-£500 0.1%, 500-1000 0.2%, 1000-10000 0.5%, then the applicable interest rate could either be 0.5% of the entire balance (since the account balance sits in the top interest tier) or (0.1% 500)+(0.2% 500)+(0.5%*1000). In the 1st situation, we say the interest is applied to the ‘Whole’ of the account balance, and in the 2nd that it is ‘Tiered’.
ENUM: Banded, Tiered, Whole
-
BankGuaranteedIndicator BankGuaranteedIndicator boolean
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
-
Notes Notes [
]Optional additional notes to supplement the Tier/band details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftFeesCharges OverdraftFeesCharges [
]Overdraft fees and charges
-
{
}Overdraft fees and charges
-
OverdraftFeeChargeCap OverdraftFeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, AnnualReview, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
MinMaxType MinMaxType string
Min Max type
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OverdraftFeeChargeDetail OverdraftFeeChargeDetail [
]Details about the fees/charges
- minItems 1
-
{
}Details about the fees/charges
-
FeeType FeeType string
Overdraft fee type
ENUM: ArrangedOverdraft, AnnualReview, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
NegotiableIndicator NegotiableIndicator boolean
Indicates whether fee and charges are negotiable
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not.
-
IncrementalBorrowingAmount IncrementalBorrowingAmount string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeAmount FeeAmount string
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate FeeRate string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType FeeRateType string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
ENUM: Gross, Other
-
ApplicationFrequency ApplicationFrequency string
Frequency at which the overdraft charge is applied to the account
ENUM: OnClosing, OnOpening, ChargingPeriod, Daily, PerItem, Monthly, OnAnniversary, Other, PerHundredPounds, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
CalculationFrequency CalculationFrequency string
How often is the overdraft fee/charge calculated for the account.
ENUM: OnClosing, OnOpening, ChargingPeriod, Daily, PerItem, Monthly, OnAnniversary, Other, PerHundredPounds, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
Notes Notes [
]Free text for capturing any other info related to Overdraft Fees Charge Details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftFeeChargeCap OverdraftFeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, AnnualReview, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
MinMaxType MinMaxType string
Min Max type
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OtherFeeType OtherFeeType {
}Other Fee type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType OtherFeeRateType {
}Other fee rate type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies that are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in the standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
OverdraftFeesCharges OverdraftFeesCharges [
]Overdraft fees and charges details
-
{
}Overdraft fees and charges details
-
OverdraftFeeChargeCap OverdraftFeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, AnnualReview, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
MinMaxType MinMaxType string
Min Max type
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OverdraftFeeChargeDetail OverdraftFeeChargeDetail [
]Details about the fees/charges
- minItems 1
-
{
}Details about the fees/charges
-
FeeType FeeType string
Overdraft fee type
ENUM: ArrangedOverdraft, AnnualReview, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
NegotiableIndicator NegotiableIndicator boolean
Indicates whether fee and charges are negotiable
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not.
-
IncrementalBorrowingAmount IncrementalBorrowingAmount string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeAmount FeeAmount string
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate FeeRate string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType FeeRateType string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
ENUM: Gross, Other
-
ApplicationFrequency ApplicationFrequency string
Frequency at which the overdraft charge is applied to the account
ENUM: OnClosing, OnOpening, ChargingPeriod, Daily, PerItem, Monthly, OnAnniversary, Other, PerHundredPounds, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
CalculationFrequency CalculationFrequency string
How often is the overdraft fee/charge calculated for the account.
ENUM: OnClosing, OnOpening, ChargingPeriod, Daily, PerItem, Monthly, OnAnniversary, Other, PerHundredPounds, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
Notes Notes [
]Free text for capturing any other info related to Overdraft Fees Charge Details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftFeeChargeCap OverdraftFeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, AnnualReview, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
MinMaxType MinMaxType string
Min Max type
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OtherFeeType OtherFeeType {
}Other Fee type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType OtherFeeRateType {
}Other fee rate type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies that are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in the standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
-
OtherFeesCharges OtherFeesCharges [
]Contains details of fees and charges which are not associated with either Overdraft or features/benefits
-
{
}Contains details of fees and charges which are not associated with either Overdraft or features/benefits
-
TariffType TariffType string
TariffType which defines the fee and charges.
ENUM: Electronic, Mixed, Other
-
TariffName TariffName string
Name of the tariff
- minLength 1
- maxLength 350
-
OtherTariffType OtherTariffType {
}Other tariff type which is not in the standard list.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
FeeChargeDetail FeeChargeDetail [
]Other fees/charges details
- minItems 1
-
{
}Other fees/charges details
-
FeeCategory FeeCategory string
Categorisation of fees and charges into standard categories.
ENUM: Other, Servicing
-
FeeType FeeType string
Fee/Charge Type
ENUM: Other, ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCAccountFeeQuarterly, ServiceCFixedTariff, ServiceCBusiDepAccBreakage, ServiceCMinimumMonthlyFee, ServiceCOther
-
NegotiableIndicator NegotiableIndicator boolean
Fee/charge which is usually negotiable rather than a fixed amount
-
FeeAmount FeeAmount string
Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate FeeRate string
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType FeeRateType string
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
ENUM: Gross, Other
-
ApplicationFrequency ApplicationFrequency string
How frequently the fee/charge is applied to the account
ENUM: OnClosing, OnOpening, ChargingPeriod, Daily, PerItem, Monthly, OnAnniversary, Other, PerHundredPounds, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
CalculationFrequency CalculationFrequency string
How frequently the fee/charge is calculated
ENUM: OnClosing, OnOpening, ChargingPeriod, Daily, PerItem, Monthly, OnAnniversary, Other, PerHundredPounds, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
Notes Notes [
]Optional additional notes to supplement the fee/charge details.
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
FeeChargeCap FeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular or group of fee/charge
-
{
}Details about any caps (maximum charges) that apply to a particular or group of fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Fee/charge type which is being capped
ENUM: Other, ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCAccountFeeQuarterly, ServiceCFixedTariff, ServiceCBusiDepAccBreakage, ServiceCMinimumMonthlyFee, ServiceCOther
-
MinMaxType MinMaxType string
Min Max type
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Free text for adding extra details for fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OtherFeeCategoryType OtherFeeCategoryType {
}-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeType OtherFeeType {
}Other Fee/charge type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
FeeCategory FeeCategory string
Categorisation of fees and charges into standard categories.
ENUM: Other, Servicing
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType OtherFeeRateType {
}Other fee rate type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies not covered in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
FeeApplicableRange FeeApplicableRange {
}Range or amounts or rates for which the fee/charge applies
-
MinimumAmount MinimumAmount string
Minimum Amount on which fee/charge is applicable (where it is expressed as an amount)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
MaximumAmount MaximumAmount string
Maximum Amount on which fee is applicable (where it is expressed as an amount)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
MinimumRate MinimumRate string
Minimum rate on which fee/charge is applicable(where it is expressed as an rate)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
MaximumRate MaximumRate string
Maximum rate on which fee/charge is applicable(where it is expressed as an rate)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
-
-
FeeChargeCap FeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular or group of fee/charge
-
{
}Details about any caps (maximum charges) that apply to a particular or group of fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Fee/charge type which is being capped
ENUM: Other, ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCAccountFeeQuarterly, ServiceCFixedTariff, ServiceCBusiDepAccBreakage, ServiceCMinimumMonthlyFee, ServiceCOther
-
MinMaxType MinMaxType string
Min Max type
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Free text for adding extra details for fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
-
-
string
Balance type, in a coded form.
For a full list of enumeration values refer toExternalBalanceType1Codein ISO_External_CodeSet here .ENUM: CLAV, CLBD, FWAV, INFO, ITAV, ITBD, OPAV, OPBD, PRCD, XPCD
EXAMPLE: CLAV
-
{
}Set of elements used to fully identify the type of underlying transaction resulting in an entry.
-
Code string
Specifies the family within a domain.
-
SubCode string
Specifies the sub-product family within a specific family.
-
-
{
}-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
BeneficiaryId string
A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
EXAMPLE: Ben1- minLength 1
- maxLength 40
-
BeneficiaryType string
Specifies the Beneficiary Type.
ENUM: Trusted, Ordinary
EXAMPLE: Ordinary -
Reference string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
EXAMPLE: Towbar Club- minLength 1
- maxLength 35
-
CreditorAgent {
}Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
-
CreditorAccount {
}Provides the details to identify the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
-
{
}-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
BeneficiaryId string
A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
EXAMPLE: Ben1- minLength 1
- maxLength 40
-
BeneficiaryType string
Specifies the Beneficiary Type.
ENUM: Trusted, Ordinary
EXAMPLE: Ordinary -
Reference string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
EXAMPLE: Towbar Club- minLength 1
- maxLength 35
-
-
{
}-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
BeneficiaryId string
A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
EXAMPLE: Ben1- minLength 1
- maxLength 40
-
BeneficiaryType string
Specifies the Beneficiary Type.
ENUM: Trusted, Ordinary
EXAMPLE: Ordinary -
Reference string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
EXAMPLE: Towbar Club- minLength 1
- maxLength 35
-
CreditorAgent {
}Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
-
CreditorAccount {
}Provides the details to identify the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
-
{
}Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
-
{
}Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
-
{
}Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
-
{
}Financial institution servicing an account for the creditor.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
{
}Financial institution servicing an account for the debtor.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
{
}Provides the details to identify the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
{
}Provides the details to identify the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Beneficiary account identification.
- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
{
}Unambiguous identification of the account of the creditor, in the case of a debit transaction.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
{
}Unambiguous identification of the account of the debtor, in the case of a crebit transaction.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
string
Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see
ExternalCategoryPurpose1Codein ISO_External_CodeSet hereENUM: BONU, CASH, CBLK, CCRD, CGWV, CIPC, CONC, CORT, DCRD, DIVI, DVPM, EPAY, FCDT, FCIN, FCOL, GOVT, GP2P, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P, OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, SWEP, TAXS, TOPG, TRAD, TREA, VATX, VOST, WHLD, ZABA
-
string
Type of mandate instruction. For a full list of values see
OBExternalClassification1Codein OB_Internal_CodeSet hereENUM: FIXE, USGB, VARI
EXAMPLE: FIXE
-
string
For a full list of enumeration values see
OBExternalCommunicationMethod2Codein OB_Internal_CodeSet hereENUM: EMAL, FAXI, FILE, ONLI, POST
-
string
Indicates whether the amount is a credit or a debit. For a full list of values see
OBInternalCreditDebitCodein OB_Internal_CodeSet here
Usage: A zero amount is considered to be a credit amount.ENUM: Credit, Debit
EXAMPLE: Credit
-
string
Indicates whether the transaction is a credit or a debit entry.
For a full list of enumeration values refer toOBInternalCreditDebitCodein OB_Internal_CodeSet hereENUM: Credit, Debit
-
string
Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.
For a full list of enumeration values refer toOBInternalCreditDebitCodein OB_Internal_CodeSet hereENUM: Credit, Debit
EXAMPLE: Credit
-
{
}Set of elements used to provide details on the currency exchange.
-
SourceCurrency string
Currency from which an amount is to be converted in a currency conversion.
- pattern ^[A-Z]{3,3}$
-
TargetCurrency string
Currency into which an amount is to be converted in a currency conversion.
- pattern ^[A-Z]{3,3}$
-
UnitCurrency string
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
- pattern ^[A-Z]{3,3}$
-
ExchangeRate number
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).
-
ContractIdentification string
Unique identification to unambiguously identify the foreign exchange contract.
- minLength 1
- maxLength 35
-
QuotationDate string
Date and time at which an exchange rate is quoted. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
InstructedAmount {
}Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
string
Status of a transaction entry on the books of the account servicer.
For a full list of enumeration values refer toExternalEntryStatus1Codein ISO_External_CodeSet hereENUM: BOOK, FUTR, INFO, PDNG
-
string
Specifies the Mutability of the Transaction record.
For a full list of enumeration values refer toOBInternalTransactionMutability1Codein OB_Internal_CodeSet hereENUM: Mutable, Immutable
-
{
}- minProperties 1
-
ErrorCode string
Low level textual error code, for all enum values see
ExternalReason1CodehereEXAMPLE: AC17- minLength 4
- maxLength 4
-
Message string
A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBL doesn't standardise this field
- minLength 1
- maxLength 500
-
Path string
Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
- minLength 1
- maxLength 500
-
Url string
URL to help remediate the problem, or provide more information, or to API Reference, or help etc
-
{
}An array of detail error codes, and messages, and URLs to documentation to help remediation.
-
Id string
A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
- minLength 1
- maxLength 40
-
Code string
Deprecated
High level textual error code, to help categorise the errors.EXAMPLE: 400 BadRequest- minLength 1
- maxLength 40
-
Message string
Deprecated
Brief Error messageEXAMPLE: There is something wrong with the request parameters provided- minLength 1
- maxLength 500
-
Errors [
]- minItems 1
-
OBError1 {
}- minProperties 1
-
ErrorCode string
Low level textual error code, for all enum values see
ExternalReason1CodehereEXAMPLE: AC17- minLength 4
- maxLength 4
-
Message string
A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBL doesn't standardise this field
- minLength 1
- maxLength 500
-
Path string
Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
- minLength 1
- maxLength 500
-
Url string
URL to help remediate the problem, or provide more information, or to API Reference, or help etc
-
-
string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
string
A party’s role with respect to the related account. For a full list refer to
OBInternalAccountRole1Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.Administrator,UK.OBIE.Beneficiary,UK.OBIE.CustodianForMinor,UK.OBIE.Granter,UK.OBIE.LegalGuardian,UK.OBIE.OtherParty,UK.OBIE.PowerOfAttorney,UK.OBIE.Principal,UK.OBIE.Protector,UK.OBIE.RegisteredShareholderName,UK.OBIE.SecondaryOwner,UK.OBIE.SeniorManagingOfficial,UK.OBIE.Settlor,UK.OBIE.SuccessorOnDeath
-
string
Specifies the sub type of account (product family group)
For a full list of enumeration values refer toOBExternalCashAccountType1CodeOB_Internal_CodeSet hereENUM: CACC, CARD, CASH, CHAR, CISH, COMM, CPAC, LLSV, LOAN, MGLD, MOMA, NREX, ODFT, ONDP, OTHR, SACC, SLRY, SVGS, TAXE, TRAN, TRAS, VACC, NFCA, MORT, WALT
-
string
Specifies the type of account (personal or business).
For a full list of enumeration values refer to 'OBInternalAccountType1Code' in OB_Internal_CodeSet hereENUM: Business, Personal
-
string
Amount sub type, in a coded form. Default if not specified is BCUR of the account.
ENUM: BCUR, LCUR
-
string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
string
Specifies the switch status for the account, in a coded form.
For a full list of enumeration values refer toOBInternalSwitchStatusCodein OB_Internal_CodeSet here- x-namespaced-enum UK.CASS.NotSwitched,UK.CASS.SwitchCompleted
-
string
Legal standing of the party. For a full list refer to
OBInternalLegalStructureType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Individual- x-namespaced-enum UK.OBIE.CIC,UK.OBIE.CIO,UK.OBIE.Charity,UK.OBIE.CoOp,UK.OBIE.GeneralPartnership,UK.OBIE.Individual,UK.OBIE.LimitedLiabilityPartnership,UK.OBIE.LimitedPartnership,UK.OBIE.PrivateLimitedCompany,UK.OBIE.PublicLimitedCompany,UK.OBIE.ScottishLimitedPartnership,UK.OBIE.Sole
-
string
Party type, in a coded form. For a full list see
OBInternalPartyType1Codein OB_Internal_CodeSet hereENUM: Delegate, Joint, Sole
EXAMPLE: Joint
-
string
For a full list of enumeration values refer to
ExternalPurpose1Codein ISO_External_CodeSet hereENUM: BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, INTP, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GIFT, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RRCT, RRTP, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, IPAY, IPCA, IPDO, IPEA, IPEC, IPEW, IPPS, IPRT, IPU2, IPUW, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SPSP, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER, BOND, CABD, CAEQ, CBCR, DBCR, DICL, EQTS, FLCR, EFTC, EFTD, MOMA, RAPI, GAMB, LOTT, AMEX, SASW, AUCO, PCOM, PDEP, PLDS, PLRF, GAFA, GAHO, CPEN, DEPD, RETL, DEBT
- minLength 1
- maxLength 4
-
string
Specifies the scheduled payment date type requested. For a full list of enumeration values refer to
OBInternalScheduleType1Codein OB_Internal_CodeSet hereENUM: Arrival, Execution
EXAMPLE: Arrival
-
string
Specifies the status of the standing order in code form. For a full list of enumeration values refer to 'ExternalMandateStatus1Code' in ISO_External_Codeset here
ENUM: ACTV, CANC, EXPI, SUSP
EXAMPLE: ACTV
-
string
Amount type, in a coded form.
EXAMPLE: UK.OBIE.CreditLimit- x-namespaced-enum UK.OBIE.ArrearsClosingBalance,UK.OBIE.AvailableBalance,UK.OBIE.AverageBalanceWhenInCredit,UK.OBIE.AverageBalanceWhenInDebit,UK.OBIE.AverageDailyBalance,UK.OBIE.BalanceTransferClosingBalance,UK.OBIE.CashClosingBalance,UK.OBIE.ClosingBalance,UK.OBIE.CreditLimit,UK.OBIE.CurrentPayment,UK.OBIE.DirectDebitPaymentDue,UK.OBIE.FSCSInsurance,UK.OBIE.MinimumPaymentDue,UK.OBIE.PendingTransactionsBalance,UK.OBIE.PreviousClosingBalance,UK.OBIE.PreviousPayment,UK.OBIE.PurchaseClosingBalance,UK.OBIE.StartingBalance,UK.OBIE.TotalAdjustments,UK.OBIE.TotalCashAdvances,UK.OBIE.TotalCharges,UK.OBIE.TotalCredits,UK.OBIE.TotalDebits,UK.OBIE.TotalPurchases
-
string
Benefit type, in a coded form. For a full list of values see
OBInternalStatementBenefitType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Cashback- x-namespaced-enum UK.OBIE.Cashback,UK.OBIE.Insurance,UK.OBIE.TravelDiscount,UK.OBIE.TravelInsurance
-
string
Date time type, in a coded form. For a full list of values see
OBInternalStatementDateTimeType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.NextStatement- x-namespaced-enum UK.OBIE.BalanceTransferPromoEnd,UK.OBIE.DirectDebitDue,UK.OBIE.LastPayment,UK.OBIE.LastStatement,UK.OBIE.NextStatement,UK.OBIE.PaymentDue,UK.OBIE.PurchasePromoEnd,UK.OBIE.StatementAvailable
-
string
How frequently the fee is applied to the Account. For a full list of values see
OBInternalStatementFeeFrequency1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.StatementMonthly- x-namespaced-enum UK.OBIE.ChargingPeriod,UK.OBIE.PerTransactionAmount,UK.OBIE.PerTransactionPercentage,UK.OBIE.Quarterly,UK.OBIE.StatementMonthly,UK.OBIE.Weekly
-
string
Description that may be available for the statement fee rate type. For a full list of values see
OBInternalStatementFeeRateType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.AER- x-namespaced-enum UK.OBIE.AER,UK.OBIE.EAR
-
string
Fee type, in a coded form. For a full list of values see
OBInternalStatementFeeType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Annual- x-namespaced-enum UK.OBIE.Annual,UK.OBIE.BalanceTransfer,UK.OBIE.CashAdvance,UK.OBIE.CashTransaction,UK.OBIE.ForeignCashTransaction,UK.OBIE.ForeignTransaction,UK.OBIE.Gambling,UK.OBIE.LatePayment,UK.OBIE.MoneyTransfer,UK.OBIE.Monthly,UK.OBIE.Overlimit,UK.OBIE.PostalOrder,UK.OBIE.PrizeEntry,UK.OBIE.StatementCopy,UK.OBIE.Total
-
string
Specifies the statement fee type requested. For a full list of values see
OBInternalStatementInterestFrequency1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Monthly- x-namespaced-enum UK.OBIE.Daily,UK.OBIE.HalfYearly,UK.OBIE.Monthly,UK.OBIE.PerStatementDate,UK.OBIE.Quarterly,UK.OBIE.Weekly,UK.OBIE.Yearly
-
string
Description that may be available for the statement Interest rate type.
EXAMPLE: UK.OBIE.FixedRate- x-namespaced-enum UK.OBIE.BOEBaseRate,UK.OBIE.FixedRate,UK.OBIE.Gross,UK.OBIE.LoanProviderBaseRate,UK.OBIE.Net
-
string
Interest amount type, in a coded form. For a full list of values see
OBInternalStatementInterestType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Total- x-namespaced-enum UK.OBIE.BalanceTransfer,UK.OBIE.Cash,UK.OBIE.EstimatedNext,UK.OBIE.Purchase,UK.OBIE.Total
-
string
Statement rate type, in a coded form. For a full list of values see
OBInternalStatementRateType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.AnnualCash- x-namespaced-enum UK.OBIE.AnnualBalanceTransfer,UK.OBIE.AnnualBalanceTransferAfterPromo,UK.OBIE.AnnualBalanceTransferPromo,UK.OBIE.AnnualCash,UK.OBIE.AnnualPurchase,UK.OBIE.AnnualPurchaseAfterPromo,UK.OBIE.AnnualPurchasePromo,UK.OBIE.MonthlyBalanceTransfer,UK.OBIE.MonthlyCash,UK.OBIE.MonthlyPurchase
-
string
Statement type, in a coded form. For a full list of values see
OBInternalStatementType1Codein OB_Internal_CodeSet hereENUM: AccountClosure, AccountOpening, Annual, Interim, RegularPeriodic
EXAMPLE: RegularPeriodic
-
string
Statement value type, in a coded form. For a full list of values see
OBInternalStatementValueType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Credit- x-namespaced-enum UK.OBIE.AirMilesPoints,UK.OBIE.AirMilesPointsBalance,UK.OBIE.Credits,UK.OBIE.Debits,UK.OBIE.HotelPoints,UK.OBIE.HotelPointsBalance,UK.OBIE.RetailShoppingPoints,UK.OBIE.RetailShoppingPointsBalance
-
string
For a full list of enumeration values refer to
OBFrequency2Codein OB_Internal_CodeSet hereENUM: YEAR, DAIL, INDA, MNTH, QURT, MIAN, TEND, MOVE, WEEK
-
string
Individual Definitions: ADHO - Adhoc YEAR - Annual DAIL - Daily INDA - Intra Day MNTH - Monthly QURT - Quarterly WEEK - Weekly
ENUM: ADHO, YEAR, DAIL, INDA, MNTH, QURT, MIAN, WEEK
-
string
For a full list of enumeration values refer to
ExternalDocumentFormat1Codein OB_Internal_CodeSet hereENUM: DPDF, DXML, SDSH, WORD, XSLT
-
string
Low level textual error code, for all enum values see
ExternalReason1CodehereEXAMPLE: AC17- minLength 4
- maxLength 4
-
{
}Provides further details of the mandate signed between the creditor and the debtor.
-
MandateIdentification string
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.
EXAMPLE: Golfers- minLength 1
- maxLength 35
-
FirstPaymentDateTime string
The date on which the first payment for a recurrent credit transfer will be made.
EXAMPLE: 2024-04-25T12:46:49.425Z- format date-time
-
FinalPaymentDateTime string
The date on which the final payment for a recurrent credit transfer will be made.
EXAMPLE: 2024-04-25T12:46:49.425Z- format date-time
-
Frequency {
}Regularity with which credit transfer instructions are to be created and processed
-
Type string
For a full list of values see
OBFrequency6Codein OB_Internal_CodeSet hereENUM: YEAR, FRTN, MNTH, QURT, MIAN, WEEK, FOWK, TWMH, FOMH
EXAMPLE: MNTH -
PointInTime string
Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or moment within a specified frequency type. Note: should not be used alongside
CountPerPeriod.EXAMPLE: 01- maxLength 2
-
-
-
{
}Provides further details of the mandate signed between the creditor and the debtor.
-
MandateIdentification string
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.
EXAMPLE: Golfers- minLength 1
- maxLength 35
-
FirstPaymentDateTime string
The date on which the first payment for a recurrent credit transfer will be made.
EXAMPLE: 2024-04-25T12:46:49.425Z- format date-time
-
FinalPaymentDateTime string
The date on which the final payment for a recurrent credit transfer will be made.
EXAMPLE: 2024-04-25T12:46:49.425Z- format date-time
-
Frequency {
}Regularity with which credit transfer instructions are to be created and processed
-
Type string
For a full list of values see
OBFrequency6Codein OB_Internal_CodeSet hereENUM: YEAR, FRTN, MNTH, QURT, MIAN, WEEK, FOWK, TWMH, FOMH
EXAMPLE: MNTH
-
-
-
{
}Details of the merchant involved in the transaction.
-
MerchantName string
Name by which the merchant is known.
- minLength 1
- maxLength 350
-
MerchantCategoryCode string
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
- minLength 3
- maxLength 4
-
MerchantCategory1Name string
Tier 1 Merchant Category Name
- minLength 1
- maxLength 255
-
MerchantCategory2Name string
Tier 2 Merchant Category Name
- minLength 1
- maxLength 255
-
MerchantCategory3Name string
Tier 3 Merchant Category Name
- minLength 1
- maxLength 255
-
FcaCode string
Financial Conduct Authority Code
- minLength 1
- maxLength 255
-
FcaCategory string
Financial Conduct Authority Category
- minLength 1
- maxLength 255
-
CarbonScore {
}Carbon emission scoring details
-
totalKgCo2e number
Total Kg of CO2 emitted
- minLength 1
- maxLength 350
-
carbonModelVersion string
Carbon Model Version
- minLength 1
- maxLength 350
-
-
-
PCA {
}-
ProductDetails ProductDetails {
}-
Segment Segment [
]Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to PCA products, they are segmented in relation to different markets that they wish to focus on.
-
string
Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to PCA products, they are segmented in relation to different markets that they wish to focus on.
ENUM: Basic, BenefitAndReward, CreditInterest, Cashback, General, Graduate, Other, Overdraft, Packaged, Premium, Reward, Student, YoungAdult, Youth
-
-
MonthlyMaximumCharge MonthlyMaximumCharge string
The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
Notes Notes [
]Optional additional notes to supplement the Core product details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
-
CreditInterest CreditInterest {
}Details about the interest that may be payable to the PCA account holders
-
TierBandSet TierBandSet [
]The group of tiers or bands for which credit interest can be applied.
- minItems 1
-
{
}The group of tiers or bands for which credit interest can be applied.
-
TierBandMethod TierBandMethod string
The methodology of how credit interest is charged. It can be:-
-
Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases.
-
Tiered Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance.
-
Whole The same interest rate is applied irrespective of the PCA balance
ENUM: Tiered, Whole
-
-
CalculationMethod CalculationMethod string
Methods of calculating interest
ENUM: Compound, SimpleInterest
-
Destination Destination string
Describes whether accrued interest is payable only to the PCA or to another bank account
ENUM: PayAway, SelfCredit
-
Notes Notes [
]Optional additional notes to supplement the Tier Band Set details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
TierBand TierBand [
]Tier Band Details
- minItems 1
-
{
}Tier Band Details
-
Identification Identification string
Unique and unambiguous identification of a Tier Band for a PCA.
- minLength 1
- maxLength 35
-
TierValueMinimum TierValueMinimum string
Minimum deposit value for which the credit interest tier applies.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
TierValueMaximum TierValueMaximum string
Maximum deposit value for which the credit interest tier applies.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CalculationFrequency CalculationFrequency string
How often is credit interest calculated for the account.
ENUM: PerAcademicTerm, Daily, HalfYearly, Monthly, Other, Quarterly, PerStatementDate, Weekly, Yearly
-
ApplicationFrequency ApplicationFrequency string
How often is interest applied to the PCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's PCA.
ENUM: PerAcademicTerm, Daily, HalfYearly, Monthly, Other, Quarterly, PerStatementDate, Weekly, Yearly
-
DepositInterestAppliedCoverage DepositInterestAppliedCoverage string
Amount on which Interest applied.
ENUM: Tiered, Whole
-
FixedVariableInterestRateType FixedVariableInterestRateType string
Type of interest rate, Fixed or Variable
ENUM: Fixed, Variable
-
AER AER string
The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
BankInterestRateType BankInterestRateType string
Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the PCA.
ENUM: LinkedBaseRate, Gross, Net, Other
-
BankInterestRate BankInterestRate string
Bank Interest for the PCA product
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
Notes Notes [
]Optional additional notes to supplement the Tier Band details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherBankInterestType OtherBankInterestType {
}Other interest rate types which are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies that are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in the standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
Overdraft Overdraft {
}Details about Overdraft rates, fees & charges
-
Notes Notes [
]Associated Notes about the overdraft rates
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftTierBandSet OverdraftTierBandSet [
]Tier band set details
- minItems 1
-
{
}Tier band set details
-
TierBandMethod TierBandMethod string
The methodology of how overdraft is charged. It can be: 'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). 'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation 'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation.
ENUM: Tiered, Whole, Banded
-
OverdraftType OverdraftType string
An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time.
ENUM: Committed, OnDemand, Other
-
Identification Identification string
Unique and unambiguous identification of a Tier Band for a overdraft product.
- minLength 1
- maxLength 35
-
AuthorisedIndicator AuthorisedIndicator boolean
Indicates if the Overdraft is authorised (Y) or unauthorised (N)
-
BufferAmount BufferAmount string
When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
Notes Notes [
]Optional additional notes to supplement the overdraft Tier Band Set details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftTierBand OverdraftTierBand [
]Provides overdraft details for a specific tier or band
- minItems 1
-
{
}Provides overdraft details for a specific tier or band
-
Identification Identification string
Unique and unambiguous identification of a Tier Band for a overdraft.
- minLength 1
- maxLength 35
-
TierValueMin TierValueMin string
Minimum value of Overdraft Tier/Band
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
TierValueMax TierValueMax string
Maximum value of Overdraft Tier/Band
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
OverdraftInterestChargingCoverage OverdraftInterestChargingCoverage string
Interest charged on whole amount or tiered/banded
ENUM: Tiered, Whole
-
BankGuaranteedIndicator BankGuaranteedIndicator boolean
Indicates that a bank provides the overdraft limit up to TierValueMIn to all customers automatically
-
EAR EAR string
EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft.
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
RepresentativeAPR RepresentativeAPR string
An annual percentage rate (APR) is the annual rate charged for borrowing or earned through an investment. APR is expressed as a percentage that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction but does not take compounding into account.
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
Notes Notes [
]Optional additional notes to supplement the Tier/band details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftFeesCharges OverdraftFeesCharges [
]Overdraft fees and charges
-
{
}Overdraft fees and charges
-
OverdraftFeeChargeCap OverdraftFeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, AnnualReview, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Specifies for the overdraft control feature/benefit
-
MinMaxType MinMaxType string
Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: AcademicTerm, Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OverdraftFeeChargeDetail OverdraftFeeChargeDetail [
]Details about the fees/charges
- minItems 1
-
{
}Details about the fees/charges
-
FeeType FeeType string
Overdraft fee type
ENUM: ArrangedOverdraft, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, AnnualReview, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Specifies for the overdraft control feature/benefit
-
IncrementalBorrowingAmount IncrementalBorrowingAmount string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeAmount FeeAmount string
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate FeeRate string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType FeeRateType string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
ENUM: LinkedBaseRate, Gross, Net, Other
-
ApplicationFrequency ApplicationFrequency string
Frequency at which the overdraft charge is applied to the account
ENUM: AccountClosing, AccountOpening, AcademicTerm, ChargingPeriod, Daily, PerItem, Monthly, OnAccountAnniversary, Other, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
CalculationFrequency CalculationFrequency string
How often is the overdraft fee/charge calculated for the account.
ENUM: AccountClosing, AccountOpening, AcademicTerm, ChargingPeriod, Daily, PerItem, Monthly, OnAccountAnniversary, Other, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
Notes Notes [
]Free text for capturing any other info related to Overdraft Fees Charge Details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType {
}Other Fee type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType OtherFeeRateType {
}Other fee rate type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies that are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in the standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OverdraftFeeChargeCap OverdraftFeeChargeCap {
}Details about any caps (maximum charges) that apply to a particular fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, AnnualReview, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Specifies for the overdraft control feature/benefit
-
MinMaxType MinMaxType string
Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: AcademicTerm, Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
-
-
OverdraftFeesCharges OverdraftFeesCharges [
]Overdraft fees and charges details
-
{
}Overdraft fees and charges details
-
OverdraftFeeChargeCap OverdraftFeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, AnnualReview, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Specifies for the overdraft control feature/benefit
-
MinMaxType MinMaxType string
Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: AcademicTerm, Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OverdraftFeeChargeDetail OverdraftFeeChargeDetail [
]Details about the fees/charges
- minItems 1
-
{
}Details about the fees/charges
-
FeeType FeeType string
Overdraft fee type
ENUM: ArrangedOverdraft, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, AnnualReview, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Specifies for the overdraft control feature/benefit
-
IncrementalBorrowingAmount IncrementalBorrowingAmount string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeAmount FeeAmount string
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate FeeRate string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType FeeRateType string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
ENUM: LinkedBaseRate, Gross, Net, Other
-
ApplicationFrequency ApplicationFrequency string
Frequency at which the overdraft charge is applied to the account
ENUM: AccountClosing, AccountOpening, AcademicTerm, ChargingPeriod, Daily, PerItem, Monthly, OnAccountAnniversary, Other, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
CalculationFrequency CalculationFrequency string
How often is the overdraft fee/charge calculated for the account.
ENUM: AccountClosing, AccountOpening, AcademicTerm, ChargingPeriod, Daily, PerItem, Monthly, OnAccountAnniversary, Other, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
Notes Notes [
]Free text for capturing any other info related to Overdraft Fees Charge Details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType {
}Other Fee type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType OtherFeeRateType {
}Other fee rate type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies that are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in the standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OverdraftFeeChargeCap OverdraftFeeChargeCap {
}Details about any caps (maximum charges) that apply to a particular fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, AnnualReview, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Specifies for the overdraft control feature/benefit
-
MinMaxType MinMaxType string
Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: AcademicTerm, Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
-
-
-
OtherFeesCharges OtherFeesCharges {
}Contains details of fees and charges which are not associated with either borrowing or features/benefits
-
FeeChargeDetail FeeChargeDetail [
]Other fees/charges details
- minItems 1
-
{
}Other fees/charges details
-
FeeCategory FeeCategory string
Categorisation of fees and charges into standard categories.
ENUM: Other, Servicing
-
FeeType FeeType string
Fee/Charge Type
ENUM: ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCOther, Other
-
FeeAmount FeeAmount string
Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate FeeRate string
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType FeeRateType string
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
ENUM: LinkedBaseRate, Gross, Net, Other
-
ApplicationFrequency ApplicationFrequency string
How frequently the fee/charge is applied to the account
ENUM: AccountClosing, AccountOpening, AcademicTerm, ChargingPeriod, Daily, PerItem, Monthly, OnAccountAnniversary, Other, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
CalculationFrequency CalculationFrequency string
How frequently the fee/charge is calculated
ENUM: AccountClosing, AccountOpening, AcademicTerm, ChargingPeriod, Daily, PerItem, Monthly, OnAccountAnniversary, Other, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
Notes Notes [
]Optional additional notes to supplement the fee/charge details.
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeCategoryType OtherFeeCategoryType {
}-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeType OtherFeeType {
}Other Fee/charge type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
FeeCategory FeeCategory string
Categorisation of fees and charges into standard categories.
ENUM: Other, Servicing
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType OtherFeeRateType {
}Other fee rate type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies not covered in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
FeeChargeCap FeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Fee/charge type which is being capped
ENUM: ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCOther, Other
-
MinMaxType MinMaxType string
Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: AcademicTerm, Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Free text for adding extra details for fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
FeeApplicableRange FeeApplicableRange {
}Range or amounts or rates for which the fee/charge applies
-
MinimumAmount MinimumAmount string
Minimum Amount on which fee/charge is applicable (where it is expressed as an amount)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
MaximumAmount MaximumAmount string
Maximum Amount on which fee is applicable (where it is expressed as an amount)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
MinimumRate MinimumRate string
Minimum rate on which fee/charge is applicable(where it is expressed as an rate)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
MaximumRate MaximumRate string
Maximum rate on which fee/charge is applicable(where it is expressed as an rate)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
-
-
FeeChargeCap FeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Fee/charge type which is being capped
ENUM: ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCOther, Other
-
MinMaxType MinMaxType string
Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: AcademicTerm, Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Free text for adding extra details for fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
-
{
}-
PartyId string
A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
EXAMPLE: PXSIF023- minLength 1
- maxLength 40
-
PartyNumber string
Number assigned by an agent to identify its customer.
EXAMPLE: 20202002- minLength 1
- maxLength 35
-
PartyType string
Party type, in a coded form. For a full list see
OBInternalPartyType1Codein OB_Internal_CodeSet hereENUM: Delegate, Joint, Sole
EXAMPLE: Joint -
Name string
Name by which a party is known and which is usually used to identify that party.
EXAMPLE: Mx Jane Smith- minLength 1
- maxLength 350
-
FullLegalName string
The full legal name of the party.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
LegalStructure string
Legal standing of the party. For a full list refer to
OBInternalLegalStructureType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Individual- x-namespaced-enum UK.OBIE.CIC,UK.OBIE.CIO,UK.OBIE.Charity,UK.OBIE.CoOp,UK.OBIE.GeneralPartnership,UK.OBIE.Individual,UK.OBIE.LimitedLiabilityPartnership,UK.OBIE.LimitedPartnership,UK.OBIE.PrivateLimitedCompany,UK.OBIE.PublicLimitedCompany,UK.OBIE.ScottishLimitedPartnership,UK.OBIE.Sole
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
BeneficialOwnership boolean
A flag to indicate a party's beneficial ownership of the related account
-
AccountRole string
A party’s role with respect to the related account. For a full list refer to
OBInternalAccountRole1Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.Administrator,UK.OBIE.Beneficiary,UK.OBIE.CustodianForMinor,UK.OBIE.Granter,UK.OBIE.LegalGuardian,UK.OBIE.OtherParty,UK.OBIE.PowerOfAttorney,UK.OBIE.Principal,UK.OBIE.Protector,UK.OBIE.RegisteredShareholderName,UK.OBIE.SecondaryOwner,UK.OBIE.SeniorManagingOfficial,UK.OBIE.Settlor,UK.OBIE.SuccessorOnDeath
-
EmailAddress string
Address for electronic mail (e-mail).
EXAMPLE: d.user@semiotec.co.jp- minLength 1
- maxLength 256
-
Phone string
Collection of information that identifies a phone number, as defined by telecom services.
EXAMPLE: +442079460000- pattern \+[0-9]{1,3}-[0-9()+\-]{1,30}
-
Mobile string
Collection of information that identifies a mobile phone number, as defined by telecom services.
EXAMPLE: +447700900000- pattern \+[0-9]{1,3}-[0-9()+\-]{1,30}
-
Relationships {
}The Party's relationships with other resources.
-
Account {
}Relationship to the Account resource.
-
Related string
Absolute URI to the related resource.
EXAMPLE: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/89019- format uri
-
Id string
Unique identification as assigned by the ASPSP to uniquely identify the related resource.
EXAMPLE: 89019- minLength 1
- maxLength 40
-
-
-
Address [
]-
OBPostalAddress7 {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
-
{
}The Party's relationships with other resources.
-
Account {
}Relationship to the Account resource.
-
Related string
Absolute URI to the related resource.
EXAMPLE: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/89019- format uri
-
Id string
Unique identification as assigned by the ASPSP to uniquely identify the related resource.
EXAMPLE: 89019- minLength 1
- maxLength 40
-
-
-
{
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
number
Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)
EXAMPLE: 0.05
-
number
Rate for Statement Interest (where it is applicable in terms of a rate rather than an amount)
EXAMPLE: 0.05
-
{
}-
Data {
}-
Account [
]-
OBAccount6 {
}Unambiguous identification of the account to which credit and debit entries are made. The following fields are optional only for accounts that are switched:
- Data.Currency
- Data.AccountCategory
- Data.AccountTypeCode
For all other accounts, the fields must be populated by the ASPSP.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
Status string
Specifies the status of account resource in code form.
For a full list of enumeration values refer toOBInternalAccountStatus1Codein OB_Internal_CodeSet hereENUM: Deleted, Disabled, Enabled, Pending, ProForma
EXAMPLE: Enabled -
StatusUpdateDateTime string
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
Currency string
Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
- pattern ^[A-Z]{3,3}$
-
AccountCategory string
Specifies the type of account (personal or business).
For a full list of enumeration values refer to 'OBInternalAccountType1Code' in OB_Internal_CodeSet hereENUM: Business, Personal
-
AccountTypeCode string
Specifies the sub type of account (product family group)
For a full list of enumeration values refer toOBExternalCashAccountType1CodeOB_Internal_CodeSet hereENUM: CACC, CARD, CASH, CHAR, CISH, COMM, CPAC, LLSV, LOAN, MGLD, MOMA, NREX, ODFT, ONDP, OTHR, SACC, SLRY, SVGS, TAXE, TRAN, TRAS, VACC, NFCA, MORT, WALT
-
Description string
Specifies the description of the account type.
- minLength 1
- maxLength 35
-
Nickname string
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
- minLength 1
- maxLength 70
-
OpeningDate string
Date on which the account and related basic services are effectively operational for the account owner. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
MaturityDate string
Maturity date of the account. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
SwitchStatus string
Specifies the switch status for the account, in a coded form.
For a full list of enumeration values refer toOBInternalSwitchStatusCodein OB_Internal_CodeSet here- x-namespaced-enum UK.CASS.NotSwitched,UK.CASS.SwitchCompleted
-
Account [
]-
{
}Provides the details to identify an account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
-
-
StatementFrequencyAndFormat [
]-
{
}Frequency and format of statments for an account
-
Frequency string
For a full list of enumeration values refer to
OBFrequency2Codein OB_Internal_CodeSet hereENUM: YEAR, DAIL, INDA, MNTH, QURT, MIAN, TEND, MOVE, WEEK
-
CommunicationMethod string
For a full list of enumeration values see
OBExternalCommunicationMethod2Codein OB_Internal_CodeSet hereENUM: EMAL, FAXI, FILE, ONLI, POST
-
Format string
For a full list of enumeration values refer to
ExternalDocumentFormat1Codein OB_Internal_CodeSet hereENUM: DPDF, DXML, SDSH, WORD, XSLT
-
DeliveryAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
-
Servicer {
}Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
-
-
-
Links {
}Links relevant to the payload
-
Self string
- format uri
-
First string
- format uri
-
Prev string
- format uri
-
Next string
- format uri
-
Last string
- format uri
-
-
Meta MetaData {
}Meta Data relevant to the payload
-
TotalPages integer
- format int32
-
FirstAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
LastAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
-
{
}-
Data {
}-
Balance [
]- minItems 1
-
{
}Set of elements used to define the balance details.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
CreditDebitIndicator string
Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.
For a full list of enumeration values refer toOBInternalCreditDebitCodein OB_Internal_CodeSet hereENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Balance type, in a coded form.
For a full list of enumeration values refer toExternalBalanceType1Codein ISO_External_CodeSet here .ENUM: CLAV, CLBD, FWAV, INFO, ITAV, ITBD, OPAV, OPBD, PRCD, XPCD
EXAMPLE: CLAV -
DateTime string
Indicates the date (and time) of the balance. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
Amount {
}Amount of money of the cash balance.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
SubType string
Balance sub type, in a coded form. Default if not specified is BCUR of the account
ENUM: BCUR, LCUR
- default BCUR
-
-
CreditLine [
]-
{
}Set of elements used to provide details on the credit line.
-
Included boolean
Indicates whether or not the credit line is included in the balance of the account. Usage: If not present, credit line is not included in the balance amount of the account.
-
Type string
Limit type, in a coded form.
For a full list of enumeration values refer toOBInternalLimitType1Codein OB_Internal_CodeSet hereENUM: Available, Credit, Emergency, Pre-Agreed, Temporary
-
Amount {
}Amount of money of the credit line.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
LocalAmount {
}Optional component providing the equivalent of Amount in local currency. Default is Local Currency (LCUR) if not specified
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
SubType string
Balance sub type, in a coded form. Default if not specified is LCUR of the account
ENUM: BCUR, LCUR
- default LCUR
-
-
-
TotalValue {
}Combined sum of all Amounts in the accounts base currency
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
Links {
}Links relevant to the payload
-
Self string
- format uri
-
First string
- format uri
-
Prev string
- format uri
-
Next string
- format uri
-
Last string
- format uri
-
-
Meta MetaData {
}Meta Data relevant to the payload
-
TotalPages integer
- format int32
-
FirstAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
LastAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
-
{
}-
Data {
}-
Beneficiary [
]-
OBBeneficiary5 {
}-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
BeneficiaryId string
A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
EXAMPLE: Ben1- minLength 1
- maxLength 40
-
BeneficiaryType string
Specifies the Beneficiary Type.
ENUM: Trusted, Ordinary
EXAMPLE: Ordinary -
Reference string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
EXAMPLE: Towbar Club- minLength 1
- maxLength 35
-
CreditorAgent {
}Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
-
CreditorAccount {
}Provides the details to identify the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
-
-
-
Links {
}Links relevant to the payload
-
Self string
- format uri
-
First string
- format uri
-
Prev string
- format uri
-
Next string
- format uri
-
Last string
- format uri
-
-
Meta MetaData {
}Meta Data relevant to the payload
-
TotalPages integer
- format int32
-
FirstAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
LastAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
-
{
}-
Data {
}-
Permissions [
]- minItems 1
-
string
Specifies the Open Banking account access data types.
This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
For a full list of enumeration values refer toOBInternalPermissions1Codein OB_Internal_CodeSet hereENUM: ReadAccountsBasic, ReadAccountsDetail, ReadBalances, ReadBeneficiariesBasic, ReadBeneficiariesDetail, ReadDirectDebits, ReadOffers, ReadPAN, ReadParty, ReadPartyPSU, ReadProducts, ReadScheduledPaymentsBasic, ReadScheduledPaymentsDetail, ReadStandingOrdersBasic, ReadStandingOrdersDetail, ReadStatementsBasic, ReadStatementsDetail, ReadTransactionsBasic, ReadTransactionsCredits, ReadTransactionsDebits, ReadTransactionsDetail
-
ExpirationDateTime string
Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
TransactionFromDateTime string
Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
TransactionToDateTime string
Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
Risk {
}The Risk section is sent by the initiating party to the ASPSP.
It is used to specify additional details for risk scoring for Account Info.
-
-
{
}-
Data {
}-
ConsentId string
Unique identification as assigned to identify the account access consent resource.
- minLength 1
- maxLength 128
-
CreationDateTime string
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2024-05-29T00:00:00Z- format date-time
-
Status string
Specifies the status of consent resource in code form.
ENUM: AWAU, RJCT, AUTH, EXPD, CANC
-
StatusReason [
]Specifies the status reason.
-
OBStatusReason {
}-
StatusReasonCode string
Specifies the status reason in a code form. For a full description see
OBExternalStatusReason1CodehereEXAMPLE: U004- minLength 1
- maxLength 4
-
StatusReasonDescription string
Description supporting the StatusReasonCode.
EXAMPLE: Permissions field is missing- minLength 1
- maxLength 500
-
Path string
Recommended but optional reference to JSON path if relevant to the StatusReasonCode.
EXAMPLE: Data.Permissions- minLength 1
- maxLength 500
-
-
-
StatusUpdateDateTime string
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
Permissions [
]- minItems 1
-
string
Specifies the Open Banking account access data types.
This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
For a full list of enumeration values refer toOBInternalPermissions1Codein OB_Internal_CodeSet hereENUM: ReadAccountsBasic, ReadAccountsDetail, ReadBalances, ReadBeneficiariesBasic, ReadBeneficiariesDetail, ReadDirectDebits, ReadOffers, ReadPAN, ReadParty, ReadPartyPSU, ReadProducts, ReadScheduledPaymentsBasic, ReadScheduledPaymentsDetail, ReadStandingOrdersBasic, ReadStandingOrdersDetail, ReadStatementsBasic, ReadStatementsDetail, ReadTransactionsBasic, ReadTransactionsCredits, ReadTransactionsDebits, ReadTransactionsDetail
-
ExpirationDateTime string
Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
TransactionFromDateTime string
Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
TransactionToDateTime string
Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
Risk {
}The Risk section is sent by the initiating party to the ASPSP.
It is used to specify additional details for risk scoring for Account Info. -
Links {
}Links relevant to the payload
-
Self string
- format uri
-
First string
- format uri
-
Prev string
- format uri
-
Next string
- format uri
-
Last string
- format uri
-
-
Meta MetaData {
}Meta Data relevant to the payload
-
TotalPages integer
- format int32
-
FirstAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
LastAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
-
{
}-
Statement [
]-
OBStatement2 {
}Provides further details on a statement resource.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
StatementId string
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
EXAMPLE: 8sfhke-sifhkeuf-97813- minLength 1
- maxLength 40
-
StatementReference string
Unique reference for the statement. This reference may be optionally populated if available.
EXAMPLE: 002- minLength 1
- maxLength 35
-
Type string
Statement type, in a coded form. For a full list of values see
OBInternalStatementType1Codein OB_Internal_CodeSet hereENUM: AccountClosure, AccountOpening, Annual, Interim, RegularPeriodic
EXAMPLE: RegularPeriodic -
StartDateTime string
Date and time at which the statement period starts. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
EndDateTime string
Date and time at which the statement period ends. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
CreationDateTime string
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2024-05-29T00:00:00Z- format date-time
-
StatementDescription [
]-
string
Other descriptions that may be available for the statement resource.
EXAMPLE: August 2017 Statement- minLength 1
- maxLength 500
-
-
StatementBenefit [
]-
{
}Set of elements used to provide details of a benefit or reward amount for the statement resource.
-
Type string
Benefit type, in a coded form. For a full list of values see
OBInternalStatementBenefitType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Cashback- x-namespaced-enum UK.OBIE.Cashback,UK.OBIE.Insurance,UK.OBIE.TravelDiscount,UK.OBIE.TravelInsurance
-
Amount {
}Amount of money associated with the statement benefit type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
StatementFee [
]-
{
}Set of elements used to provide details of a fee for the statement resource.
-
Description string
Description that may be available for the statement fee.
EXAMPLE: International usage charge- minLength 1
- maxLength 128
-
CreditDebitIndicator string
Indicates whether the amount is a credit or a debit. For a full list of values see
OBInternalCreditDebitCodein OB_Internal_CodeSet here
Usage: A zero amount is considered to be a credit amount.ENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Fee type, in a coded form. For a full list of values see
OBInternalStatementFeeType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Annual- x-namespaced-enum UK.OBIE.Annual,UK.OBIE.BalanceTransfer,UK.OBIE.CashAdvance,UK.OBIE.CashTransaction,UK.OBIE.ForeignCashTransaction,UK.OBIE.ForeignTransaction,UK.OBIE.Gambling,UK.OBIE.LatePayment,UK.OBIE.MoneyTransfer,UK.OBIE.Monthly,UK.OBIE.Overlimit,UK.OBIE.PostalOrder,UK.OBIE.PrizeEntry,UK.OBIE.StatementCopy,UK.OBIE.Total
-
Rate number
Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)
EXAMPLE: 0.05 -
RateType string
Description that may be available for the statement fee rate type. For a full list of values see
OBInternalStatementFeeRateType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.AER- x-namespaced-enum UK.OBIE.AER,UK.OBIE.EAR
-
Frequency string
How frequently the fee is applied to the Account. For a full list of values see
OBInternalStatementFeeFrequency1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.StatementMonthly- x-namespaced-enum UK.OBIE.ChargingPeriod,UK.OBIE.PerTransactionAmount,UK.OBIE.PerTransactionPercentage,UK.OBIE.Quarterly,UK.OBIE.StatementMonthly,UK.OBIE.Weekly
-
Amount {
}Amount of money associated with the statement fee type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
StatementInterest [
]-
{
}Set of elements used to provide details of a generic interest amount related to the statement resource.
-
Description string
Description that may be available for the statement interest.
EXAMPLE: Interest occurred over statement duration- minLength 1
- maxLength 128
-
CreditDebitIndicator string
Indicates whether the amount is a credit or a debit. For a full list of values see
OBInternalCreditDebitCodein OB_Internal_CodeSet here
Usage: A zero amount is considered to be a credit amount.ENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Interest amount type, in a coded form. For a full list of values see
OBInternalStatementInterestType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Total- x-namespaced-enum UK.OBIE.BalanceTransfer,UK.OBIE.Cash,UK.OBIE.EstimatedNext,UK.OBIE.Purchase,UK.OBIE.Total
-
Rate number
Rate for Statement Interest (where it is applicable in terms of a rate rather than an amount)
EXAMPLE: 0.05 -
RateType string
Interest amount type, in a coded form. For a full list of values see
OBInternalStatementInterestType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Total- x-namespaced-enum UK.OBIE.BalanceTransfer,UK.OBIE.Cash,UK.OBIE.EstimatedNext,UK.OBIE.Purchase,UK.OBIE.Total
-
Frequency string
Specifies the statement fee type requested. For a full list of values see
OBInternalStatementInterestFrequency1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Monthly- x-namespaced-enum UK.OBIE.Daily,UK.OBIE.HalfYearly,UK.OBIE.Monthly,UK.OBIE.PerStatementDate,UK.OBIE.Quarterly,UK.OBIE.Weekly,UK.OBIE.Yearly
-
Amount {
}Amount of money associated with the statement interest amount type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
StatementAmount [
]-
{
}Set of elements used to provide details of a generic amount for the statement resource.
-
CreditDebitIndicator string
Indicates whether the amount is a credit or a debit. For a full list of values see
OBInternalCreditDebitCodein OB_Internal_CodeSet here
Usage: A zero amount is considered to be a credit amount.ENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Amount type, in a coded form.
EXAMPLE: UK.OBIE.CreditLimit- x-namespaced-enum UK.OBIE.ArrearsClosingBalance,UK.OBIE.AvailableBalance,UK.OBIE.AverageBalanceWhenInCredit,UK.OBIE.AverageBalanceWhenInDebit,UK.OBIE.AverageDailyBalance,UK.OBIE.BalanceTransferClosingBalance,UK.OBIE.CashClosingBalance,UK.OBIE.ClosingBalance,UK.OBIE.CreditLimit,UK.OBIE.CurrentPayment,UK.OBIE.DirectDebitPaymentDue,UK.OBIE.FSCSInsurance,UK.OBIE.MinimumPaymentDue,UK.OBIE.PendingTransactionsBalance,UK.OBIE.PreviousClosingBalance,UK.OBIE.PreviousPayment,UK.OBIE.PurchaseClosingBalance,UK.OBIE.StartingBalance,UK.OBIE.TotalAdjustments,UK.OBIE.TotalCashAdvances,UK.OBIE.TotalCharges,UK.OBIE.TotalCredits,UK.OBIE.TotalDebits,UK.OBIE.TotalPurchases
-
Amount {
}Amount of money of the cash balance.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
SubType string
The amount in the domestic or base accounting currency. Default is Base Currency (BCUR) if not specified
ENUM: BCUR, LCUR
- default BCUR
-
-
LocalAmount {
}Optional component providing the equivalent of Amount in local currency.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
SubType string
The amount in the local market currency for which the asset is held. Default is Local Currency (LCUR) if not specified
ENUM: BCUR, LCUR
- default LCUR
-
-
-
-
StatementDateTime [
]-
{
}Set of elements used to provide details of a generic date time for the statement resource.
-
DateTime string
Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2024-05-29T00:00:00Z- format date-time
-
Type string
Date time type, in a coded form. For a full list of values see
OBInternalStatementDateTimeType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.NextStatement- x-namespaced-enum UK.OBIE.BalanceTransferPromoEnd,UK.OBIE.DirectDebitDue,UK.OBIE.LastPayment,UK.OBIE.LastStatement,UK.OBIE.NextStatement,UK.OBIE.PaymentDue,UK.OBIE.PurchasePromoEnd,UK.OBIE.StatementAvailable
-
-
-
StatementRate [
]-
{
}Set of elements used to provide details of a generic rate related to the statement resource.
-
Rate string
Rate associated with the statement rate type.
EXAMPLE: 0.224- maxLength 40
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
Type string
Statement rate type, in a coded form. For a full list of values see
OBInternalStatementRateType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.AnnualCash- x-namespaced-enum UK.OBIE.AnnualBalanceTransfer,UK.OBIE.AnnualBalanceTransferAfterPromo,UK.OBIE.AnnualBalanceTransferPromo,UK.OBIE.AnnualCash,UK.OBIE.AnnualPurchase,UK.OBIE.AnnualPurchaseAfterPromo,UK.OBIE.AnnualPurchasePromo,UK.OBIE.MonthlyBalanceTransfer,UK.OBIE.MonthlyCash,UK.OBIE.MonthlyPurchase
-
-
-
StatementValue [
]-
{
}Set of elements used to provide details of a generic number value related to the statement resource.
-
Value string
Value associated with the statement value type.
- minLength 1
- maxLength 40
-
Type string
Statement value type, in a coded form. For a full list of values see
OBInternalStatementValueType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Credit- x-namespaced-enum UK.OBIE.AirMilesPoints,UK.OBIE.AirMilesPointsBalance,UK.OBIE.Credits,UK.OBIE.Debits,UK.OBIE.HotelPoints,UK.OBIE.HotelPointsBalance,UK.OBIE.RetailShoppingPoints,UK.OBIE.RetailShoppingPointsBalance
-
-
-
TotalValue {
}Combined sum of all Amounts in the accounts base currency
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
-
{
}-
Transaction [
]-
OBTransaction6 {
}Provides further details on an entry in the report.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
TransactionId string
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
- minLength 1
- maxLength 210
-
TransactionReference string
Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
- minLength 1
- maxLength 210
-
StatementReference [
]-
StatementReference string
Unique reference for the statement. This reference may be optionally populated if available.
EXAMPLE: 002- minLength 1
- maxLength 35
-
-
CreditDebitIndicator string
Indicates whether the transaction is a credit or a debit entry.
For a full list of enumeration values refer toOBInternalCreditDebitCodein OB_Internal_CodeSet hereENUM: Credit, Debit
-
Status string
Status of a transaction entry on the books of the account servicer.
For a full list of enumeration values refer toExternalEntryStatus1Codein ISO_External_CodeSet hereENUM: BOOK, FUTR, INFO, PDNG
-
TransactionMutability string
Specifies the Mutability of the Transaction record.
For a full list of enumeration values refer toOBInternalTransactionMutability1Codein OB_Internal_CodeSet hereENUM: Mutable, Immutable
-
BookingDateTime string
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
ValueDateTime string
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
TransactionInformation string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
- minLength 1
- maxLength 500
-
AddressLine string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
- minLength 1
- maxLength 70
-
Amount {
}Amount of money in the cash transaction entry.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
ChargeAmount {
}Transaction charges to be paid by the charge bearer.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
CurrencyExchange {
}Set of elements used to provide details on the currency exchange.
-
SourceCurrency string
Currency from which an amount is to be converted in a currency conversion.
- pattern ^[A-Z]{3,3}$
-
TargetCurrency string
Currency into which an amount is to be converted in a currency conversion.
- pattern ^[A-Z]{3,3}$
-
UnitCurrency string
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
- pattern ^[A-Z]{3,3}$
-
ExchangeRate number
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).
-
ContractIdentification string
Unique identification to unambiguously identify the foreign exchange contract.
- minLength 1
- maxLength 35
-
QuotationDate string
Date and time at which an exchange rate is quoted. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
InstructedAmount {
}Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
BankTransactionCode {
}Set of elements used to fully identify the type of underlying transaction resulting in an entry.
-
Code string
Specifies the family within a domain.
-
SubCode string
Specifies the sub-product family within a specific family.
-
-
ProprietaryBankTransactionCode {
}Set of elements to fully identify a proprietary bank transaction code.
-
Code string
Proprietary bank transaction code to identify the underlying transaction.
- minLength 1
- maxLength 35
-
Issuer string
Identification of the issuer of the proprietary bank transaction code.
- minLength 1
- maxLength 35
-
-
ExtendedProprietaryBankTransactionCodes [
]-
OBExtendedProprietaryBankTransactionCode {
}Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction
-
Code string
Proprietary bank transaction code to identify the underlying transaction.
- minLength 1
- maxLength 35
-
Issuer string
Identification of the issuer of the proprietary bank transaction code.
- minLength 1
- maxLength 35
-
Description string
Description of the code and its usage on the ASPSP channel
- minLength 1
- maxLength 500
-
-
-
Balance {
}Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
-
CreditDebitIndicator string
Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.
For a full list of enumeration values refer toOBInternalCreditDebitCodein OB_Internal_CodeSet hereENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Balance type, in a coded form.
For a full list of enumeration values refer toExternalBalanceType1Codein ISO_External_CodeSet here .ENUM: CLAV, CLBD, FWAV, INFO, ITAV, ITBD, OPAV, OPBD, PRCD, XPCD
EXAMPLE: CLAV -
Amount {
}Amount of money of the cash balance after a transaction entry is applied to the account..
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
MerchantDetails {
}Details of the merchant involved in the transaction.
-
MerchantName string
Name by which the merchant is known.
- minLength 1
- maxLength 350
-
MerchantCategoryCode string
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
- minLength 3
- maxLength 4
-
MerchantCategory1Name string
Tier 1 Merchant Category Name
- minLength 1
- maxLength 255
-
MerchantCategory2Name string
Tier 2 Merchant Category Name
- minLength 1
- maxLength 255
-
MerchantCategory3Name string
Tier 3 Merchant Category Name
- minLength 1
- maxLength 255
-
FcaCode string
Financial Conduct Authority Code
- minLength 1
- maxLength 255
-
FcaCategory string
Financial Conduct Authority Category
- minLength 1
- maxLength 255
-
CarbonScore {
}Carbon emission scoring details
-
totalKgCo2e number
Total Kg of CO2 emitted
- minLength 1
- maxLength 350
-
carbonModelVersion string
Carbon Model Version
- minLength 1
- maxLength 350
-
-
-
CreditorAgent {
}Financial institution servicing an account for the creditor.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
CreditorAccount {
}Unambiguous identification of the account of the creditor, in the case of a debit transaction.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
DebtorAgent {
}Financial institution servicing an account for the debtor.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
DebtorAccount {
}Unambiguous identification of the account of the debtor, in the case of a crebit transaction.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
CardInstrument {
}Set of elements to describe the card instrument used in the transaction.
For a full list of enumeration values refer toOBInternalCardSchemeType1Codein OB_Internal_CodeSet here-
CardSchemeName string
Name of the card scheme.
For a full list of enumeration values refer toOBInternalCardSchemeType1Codein OB_Internal_CodeSet hereENUM: AmericanExpress, Diners, Discover, MasterCard, VISA
-
AuthorisationType string
The card authorisation type.
For a full list of enumeration values refer toOBInternalCardAuthorisationType1Codein OB_Internal_CodeSet hereENUM: ConsumerDevice, Contactless, None, PIN
-
Name string
Name of the cardholder using the card instrument.
- minLength 1
- maxLength 70
-
Identification string
Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked.
- minLength 1
- maxLength 34
-
-
CategoryPurposeCode string
Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see
ExternalCategoryPurpose1Codein ISO_External_CodeSet hereENUM: BONU, CASH, CBLK, CCRD, CGWV, CIPC, CONC, CORT, DCRD, DIVI, DVPM, EPAY, FCDT, FCIN, FCOL, GOVT, GP2P, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P, OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, SWEP, TAXS, TOPG, TRAD, TREA, VATX, VOST, WHLD, ZABA
-
PaymentPurposeCode string
For a full list of enumeration values refer to
ExternalPurpose1Codein ISO_External_CodeSet hereENUM: BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, INTP, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GIFT, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RRCT, RRTP, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, IPAY, IPCA, IPDO, IPEA, IPEC, IPEW, IPPS, IPRT, IPU2, IPUW, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SPSP, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER, BOND, CABD, CAEQ, CBCR, DBCR, DICL, EQTS, FLCR, EFTC, EFTD, MOMA, RAPI, GAMB, LOTT, AMEX, SASW, AUCO, PCOM, PDEP, PLDS, PLRF, GAFA, GAHO, CPEN, DEPD, RETL, DEBT
- minLength 1
- maxLength 4
-
UltimateCreditor {
}Ultimate party to which an amount of money is due.
-
Name string
Name by which a party is known and which is usually used to identify that party.
- minLength 1
- maxLength 140
-
Identification string
Identification assigned by an institution.
- minLength 1
- maxLength 256
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
UltimateDebtor {
}Ultimate party that owes an amount of money to the (ultimate) creditor.
-
Name string
Name by which a party is known and which is usually used to identify that party.
- minLength 1
- maxLength 140
-
Identification string
Identification assigned by an institution.
- minLength 1
- maxLength 256
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
-
-
-
{
}-
Data {
}-
DirectDebit [
]-
{
}Account to or from which a cash entry is made.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
DirectDebitId string
A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.
- minLength 1
- maxLength 40
-
DirectDebitStatusCode string
Specifies the status of the standing order in code form. For a full list of enumeration values refer to 'ExternalMandateStatus1Code' in ISO_External_Codeset here
ENUM: ACTV, CANC, EXPI, SUSP
EXAMPLE: ACTV -
MandateRelatedInformation {
}Provides further details of the mandate signed between the creditor and the debtor.
-
MandateIdentification string
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.
EXAMPLE: Golfers- minLength 1
- maxLength 35
-
FirstPaymentDateTime string
The date on which the first payment for a recurrent credit transfer will be made.
EXAMPLE: 2024-04-25T12:46:49.425Z- format date-time
-
FinalPaymentDateTime string
The date on which the final payment for a recurrent credit transfer will be made.
EXAMPLE: 2024-04-25T12:46:49.425Z- format date-time
-
Frequency {
}Regularity with which credit transfer instructions are to be created and processed
-
Type string
For a full list of values see
OBFrequency6Codein OB_Internal_CodeSet hereENUM: YEAR, FRTN, MNTH, QURT, MIAN, WEEK, FOWK, TWMH, FOMH
EXAMPLE: MNTH
-
-
-
Name string
Name of Service User.
- minLength 1
- maxLength 70
-
PreviousPaymentDateTime string
Date of most recent direct debit collection. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
PreviousPaymentAmount {
}The amount of the most recent direct debit collection.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
-
Links {
}Links relevant to the payload
-
Self string
- format uri
-
First string
- format uri
-
Prev string
- format uri
-
Next string
- format uri
-
Last string
- format uri
-
-
Meta MetaData {
}Meta Data relevant to the payload
-
TotalPages integer
- format int32
-
FirstAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
LastAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
-
{
}-
Data {
}-
Offer [
]-
{
}-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
OfferId string
A unique and immutable identifier used to identify the offer resource. This identifier has no meaning to the account owner.
EXAMPLE: Offer1- minLength 1
- maxLength 40
-
OfferType string
Offer type, in a coded form. For a full list of values refer to
OBExternalOfferType1Codein OB_Internal_CodeSet hereENUM: BalanceTransfer, LimitIncrease, MoneyTransfer, Other, PromotionalRate
EXAMPLE: LimitIncrease -
Description string
Further details of the offer.
EXAMPLE: Credit limit increase for the account up to £10000.00- minLength 1
- maxLength 500
-
StartDateTime string
Date and time at which the offer starts. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2024-05-29T00:00:00Z- format date-time
-
EndDateTime string
Date and time at which the offer ends. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2024-06-29T00:00:00Z- format date-time
-
Rate string
Rate associated with the offer type.
EXAMPLE: 100.00- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
Value integer
Value associated with the offer type.
EXAMPLE: 10 -
Term string
Further details of the term of the offer.
EXAMPLE: Starting first of the month and ending at the end of year- minLength 1
- maxLength 500
-
URL string
URL (Uniform Resource Locator) where documentation on the offer can be found
EXAMPLE: http://modelbank.com/offer/offer1- minLength 1
- maxLength 256
-
Amount {
}Amount of money associated with the offer type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
Fee {
}Fee associated with the offer type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
-
Links {
}Links relevant to the payload
-
Self string
- format uri
-
First string
- format uri
-
Prev string
- format uri
-
Next string
- format uri
-
Last string
- format uri
-
-
Meta MetaData {
}Meta Data relevant to the payload
-
TotalPages integer
- format int32
-
FirstAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
LastAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
-
{
}-
Data {
}-
Party {
}-
PartyId string
A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
EXAMPLE: PXSIF023- minLength 1
- maxLength 40
-
PartyNumber string
Number assigned by an agent to identify its customer.
EXAMPLE: 20202002- minLength 1
- maxLength 35
-
PartyType string
Party type, in a coded form. For a full list see
OBInternalPartyType1Codein OB_Internal_CodeSet hereENUM: Delegate, Joint, Sole
EXAMPLE: Joint -
Name string
Name by which a party is known and which is usually used to identify that party.
EXAMPLE: Mx Jane Smith- minLength 1
- maxLength 350
-
FullLegalName string
The full legal name of the party.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
LegalStructure string
Legal standing of the party. For a full list refer to
OBInternalLegalStructureType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Individual- x-namespaced-enum UK.OBIE.CIC,UK.OBIE.CIO,UK.OBIE.Charity,UK.OBIE.CoOp,UK.OBIE.GeneralPartnership,UK.OBIE.Individual,UK.OBIE.LimitedLiabilityPartnership,UK.OBIE.LimitedPartnership,UK.OBIE.PrivateLimitedCompany,UK.OBIE.PublicLimitedCompany,UK.OBIE.ScottishLimitedPartnership,UK.OBIE.Sole
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
BeneficialOwnership boolean
A flag to indicate a party's beneficial ownership of the related account
-
AccountRole string
A party’s role with respect to the related account. For a full list refer to
OBInternalAccountRole1Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.Administrator,UK.OBIE.Beneficiary,UK.OBIE.CustodianForMinor,UK.OBIE.Granter,UK.OBIE.LegalGuardian,UK.OBIE.OtherParty,UK.OBIE.PowerOfAttorney,UK.OBIE.Principal,UK.OBIE.Protector,UK.OBIE.RegisteredShareholderName,UK.OBIE.SecondaryOwner,UK.OBIE.SeniorManagingOfficial,UK.OBIE.Settlor,UK.OBIE.SuccessorOnDeath
-
EmailAddress string
Address for electronic mail (e-mail).
EXAMPLE: d.user@semiotec.co.jp- minLength 1
- maxLength 256
-
Phone string
Collection of information that identifies a phone number, as defined by telecom services.
EXAMPLE: +442079460000- pattern \+[0-9]{1,3}-[0-9()+\-]{1,30}
-
Mobile string
Collection of information that identifies a mobile phone number, as defined by telecom services.
EXAMPLE: +447700900000- pattern \+[0-9]{1,3}-[0-9()+\-]{1,30}
-
Relationships {
}The Party's relationships with other resources.
-
Account {
}Relationship to the Account resource.
-
Related string
Absolute URI to the related resource.
EXAMPLE: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/89019- format uri
-
Id string
Unique identification as assigned by the ASPSP to uniquely identify the related resource.
EXAMPLE: 89019- minLength 1
- maxLength 40
-
-
-
Address [
]-
OBPostalAddress7 {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
-
-
Links {
}Links relevant to the payload
-
Self string
- format uri
-
First string
- format uri
-
Prev string
- format uri
-
Next string
- format uri
-
Last string
- format uri
-
-
Meta MetaData {
}Meta Data relevant to the payload
-
TotalPages integer
- format int32
-
FirstAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
LastAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
-
{
}-
Data {
}-
Party [
]-
OBParty2 {
}-
PartyId string
A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
EXAMPLE: PXSIF023- minLength 1
- maxLength 40
-
PartyNumber string
Number assigned by an agent to identify its customer.
EXAMPLE: 20202002- minLength 1
- maxLength 35
-
PartyType string
Party type, in a coded form. For a full list see
OBInternalPartyType1Codein OB_Internal_CodeSet hereENUM: Delegate, Joint, Sole
EXAMPLE: Joint -
Name string
Name by which a party is known and which is usually used to identify that party.
EXAMPLE: Mx Jane Smith- minLength 1
- maxLength 350
-
FullLegalName string
The full legal name of the party.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
LegalStructure string
Legal standing of the party. For a full list refer to
OBInternalLegalStructureType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Individual- x-namespaced-enum UK.OBIE.CIC,UK.OBIE.CIO,UK.OBIE.Charity,UK.OBIE.CoOp,UK.OBIE.GeneralPartnership,UK.OBIE.Individual,UK.OBIE.LimitedLiabilityPartnership,UK.OBIE.LimitedPartnership,UK.OBIE.PrivateLimitedCompany,UK.OBIE.PublicLimitedCompany,UK.OBIE.ScottishLimitedPartnership,UK.OBIE.Sole
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
BeneficialOwnership boolean
A flag to indicate a party's beneficial ownership of the related account
-
AccountRole string
A party’s role with respect to the related account. For a full list refer to
OBInternalAccountRole1Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.Administrator,UK.OBIE.Beneficiary,UK.OBIE.CustodianForMinor,UK.OBIE.Granter,UK.OBIE.LegalGuardian,UK.OBIE.OtherParty,UK.OBIE.PowerOfAttorney,UK.OBIE.Principal,UK.OBIE.Protector,UK.OBIE.RegisteredShareholderName,UK.OBIE.SecondaryOwner,UK.OBIE.SeniorManagingOfficial,UK.OBIE.Settlor,UK.OBIE.SuccessorOnDeath
-
EmailAddress string
Address for electronic mail (e-mail).
EXAMPLE: d.user@semiotec.co.jp- minLength 1
- maxLength 256
-
Phone string
Collection of information that identifies a phone number, as defined by telecom services.
EXAMPLE: +442079460000- pattern \+[0-9]{1,3}-[0-9()+\-]{1,30}
-
Mobile string
Collection of information that identifies a mobile phone number, as defined by telecom services.
EXAMPLE: +447700900000- pattern \+[0-9]{1,3}-[0-9()+\-]{1,30}
-
Relationships {
}The Party's relationships with other resources.
-
Account {
}Relationship to the Account resource.
-
Related string
Absolute URI to the related resource.
EXAMPLE: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/89019- format uri
-
Id string
Unique identification as assigned by the ASPSP to uniquely identify the related resource.
EXAMPLE: 89019- minLength 1
- maxLength 40
-
-
-
Address [
]-
OBPostalAddress7 {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
-
-
-
Links {
}Links relevant to the payload
-
Self string
- format uri
-
First string
- format uri
-
Prev string
- format uri
-
Next string
- format uri
-
Last string
- format uri
-
-
Meta MetaData {
}Meta Data relevant to the payload
-
TotalPages integer
- format int32
-
FirstAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
LastAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
-
{
}Product details of Other Product which is not available in the standard list
-
Data {
}Aligning with the read write specs structure.
-
Product [
]-
{
}Product details associated with the Account
-
ProductName string
The name of the Product used for marketing purposes from a customer perspective. I.e. what the customer would recognise.
EXAMPLE: 321 Product- minLength 1
- maxLength 350
-
ProductId string
Identifier within the parent organisation for the product. Must be unique in the organisation
EXAMPLE: 51B- minLength 1
- maxLength 40
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
SecondaryProductId string
Any secondary Identification which supports Product Identifier to uniquely identify the current account banking products.
EXAMPLE: CA78- minLength 1
- maxLength 70
-
ProductType string
Descriptive code for the product category. For a full list refer to
OBInternalProductType1Codein OB_Internal_CodeSet here
If ProductType - "Other" is chosen, the object OtherProductType must be populated with name, and description.ENUM: BusinessCurrentAccount, CommercialCreditCard, Other, PersonalCurrentAccount, SMELoan
EXAMPLE: PersonalCurrentAccount -
MarketingStateId string
Unique and unambiguous identification of a Product Marketing State.
EXAMPLE: 22878123- minLength 1
- maxLength 35
-
OtherProductType {
}This field provides extension to the ProductType enumeration. If ProductType - "Other" is chosen, this field must be populated with name, and description for ASPSP specific product type.
-
Name string
Name of "Other" product type.
EXAMPLE: e-Wallet- minLength 1
- maxLength 350
-
Description string
Description of "Other" product type
EXAMPLE: Virtual wallet- minLength 1
- maxLength 350
-
ProductDetails {
}-
Segment [
]-
string
Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd
ENUM: GEAS, GEBA, GEBR, GEBU, GECI, GECS, GEFB, GEFG, GEG, GEGR, GEGS, GEOT, GEOV, GEPA, GEPR, GERE, GEST, GEYA, GEYO, PSCA, PSES, PSNC, PSNP, PSRG, PSSS, PSST, PSSW
-
-
FeeFreeLength integer
The length/duration of the fee free period
-
FeeFreeLengthPeriod string
The unit of period (days, weeks, months etc.) of the promotional length
ENUM: PACT, PDAY, PHYR, PMTH, PQTR, PWEK, PYER
-
MonthlyMaximumCharge string
The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
Notes [
]-
string
Optional additional notes to supplement the Core product details
- minLength 1
- maxLength 2000
-
-
OtherSegment {
}-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
CreditInterest {
}Details about the interest that may be payable to the Account holders
-
TierBandSet [
]- minItems 1
-
{
}The group of tiers or bands for which credit interest can be applied.
-
TierBandMethod string
The methodology of how credit interest is paid/applied. It can be:-
- Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases.
- Tiered Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance.
- Whole The same interest rate is applied irrespective of the product holder's account balance
ENUM: INBA, INTI, INWH
-
CalculationMethod string
Methods of calculating interest
ENUM: ITCO, ITOT, ITSI
-
Destination string
Describes whether accrued interest is payable only to the BCA or to another bank account
ENUM: INOT, INPA, INSC
-
Notes [
]-
string
Optional additional notes to supplement the Tier Band Set details
- minLength 1
- maxLength 2000
-
-
OtherCalculationMethod {
}-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherDestination {
}-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
TierBand [
]- minItems 1
-
{
}Tier Band Details
-
Identification string
Unique and unambiguous identification of a Tier Band for the Product.
- minLength 1
- maxLength 35
-
TierValueMinimum string
Minimum deposit value for which the credit interest tier applies.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
TierValueMaximum string
Maximum deposit value for which the credit interest tier applies.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CalculationFrequency string
How often is credit interest calculated for the account.
ENUM: FQAT, FQDY, FQHY, FQMY, FQOT, FQQY, FQSD, FQWY, FQYY
-
ApplicationFrequency string
How often is interest applied to the Product for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's account.
ENUM: FQAT, FQDY, FQHY, FQMY, FQOT, FQQY, FQSD, FQWY, FQYY
-
DepositInterestAppliedCoverage string
Amount on which Interest applied.
ENUM: INBA, INTI, INWH
-
FixedVariableInterestRateType string
Type of interest rate, Fixed or Variable
ENUM: INFI, INVA
-
AER string
The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
BankInterestRateType string
Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the account holder's account.
ENUM: INBB, INFR, INGR, INLR, INNE, INOT
-
BankInterestRate string
Bank Interest for the product
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
Notes [
]-
string
Optional additional notes to supplement the Tier Band details
- minLength 1
- maxLength 2000
-
-
OtherBankInterestType {
}Other interest rate types which are not available in the standard code list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency {
}Other application frequencies that are not available in the standard code list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency {
}Other calculation frequency which is not available in the standard code set.
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
Overdraft {
}Borrowing details
-
Notes [
]-
string
Associated Notes about the overdraft rates
- minLength 1
- maxLength 2000
-
-
OverdraftTierBandSet [
]- minItems 1
-
{
}Tier band set details
-
TierBandMethod string
The methodology of how overdraft is charged. It can be: 'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). 'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation 'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation.
ENUM: INBA, INTI, INWH
-
OverdraftType string
An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time.
ENUM: OVCO, OVOD, OVOT
-
Identification string
Unique and unambiguous identification of a Tier Band for a overdraft product.
- minLength 1
- maxLength 35
-
AuthorisedIndicator boolean
Indicates if the Overdraft is authorised (Y) or unauthorised (N)
-
BufferAmount string
When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
Notes [
]-
string
Optional additional notes to supplement the overdraft Tier Band Set details
- minLength 1
- maxLength 2000
-
-
OverdraftTierBand [
]- minItems 1
-
{
}Provides overdraft details for a specific tier or band
-
Identification string
Unique and unambiguous identification of a Tier Band for a overdraft.
- minLength 1
- maxLength 35
-
TierValueMin string
Minimum value of Overdraft Tier/Band
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
TierValueMax string
Maximum value of Overdraft Tier/Band
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
EAR string
EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft.
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
AgreementLengthMin integer
Specifies the minimum length of a band for a fixed overdraft agreement
-
AgreementLengthMax integer
Specifies the maximum length of a band for a fixed overdraft agreement
-
AgreementPeriod string
Specifies the period of a fixed length overdraft agreement
ENUM: PACT, PDAY, PHYR, PMTH, PQTR, PWEK, PYER
-
OverdraftInterestChargingCoverage string
Refers to which interest rate is applied when interests are tiered. For example, if an overdraft balance is 2k and the interest tiers are:- 0- 500 0.1%, 500-1000 0.2%, 1000-10000 0.5%, then the applicable interest rate could either be 0.5% of the entire balance (since the account balance sits in the top interest tier) or (0.1% 500)+(0.2% 500)+(0.5%*1000). In the 1st situation, we say the interest is applied to the Whole of the account balance, and in the 2nd that it is Tiered .
ENUM: INBA, INTI, INWH
-
BankGuaranteedIndicator boolean
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it s part of a government scheme, or whether the rate may vary dependent on the applicant s circumstances.
-
Notes [
]-
string
Optional additional notes to supplement the Tier/band details
- minLength 1
- maxLength 2000
-
-
OverdraftFeesCharges [
]-
{
}Overdraft fees and charges
-
OverdraftFeeChargeCap [
]-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
FeeType [
]- minItems 1
-
string
Fee/charge type which is being capped
ENUM: FBAO, FBAR, FBEB, FBIT, FBOR, FBOS, FBSC, FBTO, FBUB, FBUT, FTOT, FTUT
-
MinMaxType string
Min Max type
ENUM: FMMN, FMMX
-
FeeCapOccurrence integer
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it s part of a government scheme, or whether the rate may vary dependent on the applicant s circumstances.
-
FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: PACT, PDAY, PHYR, PMTH, PQTR, PWEK, PYER
-
Notes [
]-
string
Notes related to Overdraft fee charge cap
- minLength 1
- maxLength 2000
-
-
OtherFeeType [
]-
{
}Other fee type code which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OverdraftFeeChargeDetail [
]- minItems 1
-
{
}Details about the fees/charges
-
FeeType string
Overdraft fee type
ENUM: FBAO, FBAR, FBEB, FBIT, FBOR, FBOS, FBSC, FBTO, FBUB, FBUT, FTOT, FTUT
-
NegotiableIndicator boolean
Indicates whether fee and charges are negotiable
-
OverdraftControlIndicator boolean
Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not.
-
IncrementalBorrowingAmount string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeAmount string
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
ENUM: INBB, INFR, INGR, INLR, INNE, INOT
-
ApplicationFrequency string
Frequency at which the overdraft charge is applied to the account
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
CalculationFrequency string
How often is the overdraft fee/charge calculated for the account.
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
Notes [
]-
string
Free text for capturing any other info related to Overdraft Fees Charge Details
- minLength 1
- maxLength 2000
-
-
OverdraftFeeChargeCap [
]-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
FeeType [
]- minItems 1
-
string
Fee/charge type which is being capped
ENUM: FBAO, FBAR, FBEB, FBIT, FBOR, FBOS, FBSC, FBTO, FBUB, FBUT, FTOT, FTUT
-
MinMaxType string
Min Max type
ENUM: FMMN, FMMX
-
FeeCapOccurrence integer
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it s part of a government scheme, or whether the rate may vary dependent on the applicant s circumstances.
-
FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: PACT, PDAY, PHYR, PMTH, PQTR, PWEK, PYER
-
Notes [
]-
string
Notes related to Overdraft fee charge cap
- minLength 1
- maxLength 2000
-
-
OtherFeeType [
]-
{
}Other fee type code which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OtherFeeType {
}Other Fee type which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType {
}Other fee rate type code which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency {
}Other application frequencies that are not available in the standard code list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency {
}Other calculation frequency which is not available in the standard code set.
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
OverdraftFeesCharges [
]-
{
}Overdraft fees and charges details
-
OverdraftFeeChargeCap [
]-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
FeeType [
]- minItems 1
-
string
Fee/charge type which is being capped
ENUM: FBAO, FBAR, FBEB, FBIT, FBOR, FBOS, FBSC, FBTO, FBUB, FBUT, FTOT, FTUT
-
MinMaxType string
Min Max type
ENUM: FMMN, FMMX
-
FeeCapOccurrence integer
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it s part of a government scheme, or whether the rate may vary dependent on the applicant s circumstances.
-
FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: PACT, PDAY, PHYR, PMTH, PQTR, PWEK, PYER
-
Notes [
]-
string
Notes related to Overdraft fee charge cap
- minLength 1
- maxLength 2000
-
-
OtherFeeType [
]-
{
}Other fee type code which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OverdraftFeeChargeDetail [
]- minItems 1
-
{
}Details about the fees/charges
-
FeeType string
Overdraft fee type
ENUM: FBAO, FBAR, FBEB, FBIT, FBOR, FBOS, FBSC, FBTO, FBUB, FBUT, FTOT, FTUT
-
NegotiableIndicator boolean
Indicates whether fee and charges are negotiable
-
OverdraftControlIndicator boolean
Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not.
-
IncrementalBorrowingAmount string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeAmount string
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
ENUM: INBB, INFR, INGR, INLR, INNE, INOT
-
ApplicationFrequency string
Frequency at which the overdraft charge is applied to the account
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
CalculationFrequency string
How often is the overdraft fee/charge calculated for the account.
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
Notes [
]-
string
Free text for capturing any other info related to Overdraft Fees Charge Details
- minLength 1
- maxLength 2000
-
-
OverdraftFeeChargeCap [
]-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
FeeType [
]- minItems 1
-
string
Fee/charge type which is being capped
ENUM: FBAO, FBAR, FBEB, FBIT, FBOR, FBOS, FBSC, FBTO, FBUB, FBUT, FTOT, FTUT
-
MinMaxType string
Min Max type
ENUM: FMMN, FMMX
-
FeeCapOccurrence integer
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it s part of a government scheme, or whether the rate may vary dependent on the applicant s circumstances.
-
FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: PACT, PDAY, PHYR, PMTH, PQTR, PWEK, PYER
-
Notes [
]-
string
Notes related to Overdraft fee charge cap
- minLength 1
- maxLength 2000
-
-
OtherFeeType [
]-
{
}Other fee type code which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OtherFeeType {
}Other Fee type which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType {
}Other fee rate type code which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency {
}Other application frequencies that are not available in the standard code list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency {
}Other calculation frequency which is not available in the standard code set.
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
-
LoanInterest {
}Details about the interest that may be payable to the SME Loan holders
-
Notes [
]-
string
Optional additional notes to supplement the LoanInterest
- minLength 1
- maxLength 2000
-
-
LoanInterestTierBandSet [
]- minItems 1
-
{
}The group of tiers or bands for which debit interest can be applied.
-
TierBandMethod string
The methodology of how credit interest is charged. It can be:-
- Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases.
- Tiered Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance.
- Whole The same interest rate is applied irrespective of the SME Loan balance
ENUM: INBA, INTI, INWH
-
Identification string
Loan interest tierbandset identification. Used by loan providers for internal use purpose.
- minLength 1
- maxLength 35
-
CalculationMethod string
Methods of calculating interest
ENUM: ITCO, ITOT, ITSI
-
Notes [
]-
string
Optional additional notes to supplement the Tier Band Set details
- minLength 1
- maxLength 2000
-
-
OtherCalculationMethod {
}-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
LoanInterestTierBand [
]- minItems 1
-
{
}Tier Band Details
-
Identification string
Unique and unambiguous identification of a Tier Band for a SME Loan.
- minLength 1
- maxLength 35
-
TierValueMinimum string
Minimum loan value for which the loan interest tier applies.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
TierValueMaximum string
Maximum loan value for which the loan interest tier applies.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
TierValueMinTerm integer
Minimum loan term for which the loan interest tier applies.
-
MinTermPeriod string
The unit of period (days, weeks, months etc.) of the Minimum Term
ENUM: PACT, PDAY, PHYR, PMTH, PQTR, PWEK, PYER
-
TierValueMaxTerm integer
Maximum loan term for which the loan interest tier applies.
-
MaxTermPeriod string
The unit of period (days, weeks, months etc.) of the Maximum Term
ENUM: PACT, PDAY, PHYR, PMTH, PQTR, PWEK, PYER
-
FixedVariableInterestRateType string
Type of interest rate, Fixed or Variable
ENUM: INFI, INVA
-
RepAPR string
The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. For SME Loan, this APR is the representative APR which includes any account fees.
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
LoanProviderInterestRateType string
Interest rate types, other than APR, which financial institutions may use to describe the annual interest rate payable for the SME Loan.
ENUM: INBB, INFR, INGR, INLR, INNE, INOT
-
LoanProviderInterestRate string
Loan provider Interest for the SME Loan product
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
Notes [
]-
string
Optional additional notes to supplement the Tier Band details
- minLength 1
- maxLength 2000
-
-
OtherLoanProviderInterestRateType {
}Other loan interest rate types which are not available in the standard code list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
LoanInterestFeesCharges [
]-
{
}Contains details of fees and charges which are not associated with either LoanRepayment or features/benefits
-
LoanInterestFeeChargeDetail [
]- minItems 1
-
{
}Other fees/charges details
-
FeeType string
Fee/Charge Type
ENUM: FEPF, FTOT, FYAF, FYAM, FYAQ, FYCP, FYDB, FYMI, FYXX
-
NegotiableIndicator boolean
Fee/charge which is usually negotiable rather than a fixed amount
-
FeeAmount string
Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate string
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType string
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
ENUM: INBB, INFR, INGR, INLR, INNE, INOT
-
ApplicationFrequency string
How frequently the fee/charge is applied to the account
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
CalculationFrequency string
How frequently the fee/charge is calculated
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
Notes [
]-
string
Optional additional notes to supplement the fee/charge details.
- minLength 1
- maxLength 2000
-
-
OtherFeeType {
}Other Fee/charge type which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
FeeCategory string
Categorisation of fees and charges into standard categories.
ENUM: FCOT, FCRE, FCSV
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType {
}Other fee rate type which is not in the standard rate type list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency {
}Other application frequencies not covered in the standard code list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency {
}Other calculation frequency which is not available in standard code set.
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
LoanInterestFeeChargeCap [
]-
{
}Details about any caps (minimum/maximum charges) that apply to a particular fee/charge
-
FeeType [
]- minItems 1
-
string
Fee/charge type which is being capped
ENUM: FEPF, FTOT, FYAF, FYAM, FYAQ, FYCP, FYDB, FYMI, FYXX
-
MinMaxType string
Min Max type
ENUM: FMMN, FMMX
-
FeeCapOccurrence integer
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
-
FeeCapAmount string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
Notes [
]-
string
Free text for adding extra details for fee charge cap
- minLength 1
- maxLength 2000
-
-
OtherFeeType [
]-
{
}Other fee type code which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
-
-
LoanInterestFeesCharges [
]-
{
}Contains details of fees and charges which are not associated with either LoanRepayment or features/benefits
-
LoanInterestFeeChargeDetail [
]- minItems 1
-
{
}Other fees/charges details
-
FeeType string
Fee/Charge Type
ENUM: FEPF, FTOT, FYAF, FYAM, FYAQ, FYCP, FYDB, FYMI, FYXX
-
NegotiableIndicator boolean
Fee/charge which is usually negotiable rather than a fixed amount
-
FeeAmount string
Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate string
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType string
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
ENUM: INBB, INFR, INGR, INLR, INNE, INOT
-
ApplicationFrequency string
How frequently the fee/charge is applied to the account
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
CalculationFrequency string
How frequently the fee/charge is calculated
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
Notes [
]-
string
Optional additional notes to supplement the fee/charge details.
- minLength 1
- maxLength 2000
-
-
OtherFeeType {
}Other Fee/charge type which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
FeeCategory string
Categorisation of fees and charges into standard categories.
ENUM: FCOT, FCRE, FCSV
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType {
}Other fee rate type which is not in the standard rate type list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency {
}Other application frequencies not covered in the standard code list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency {
}Other calculation frequency which is not available in standard code set.
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
LoanInterestFeeChargeCap [
]-
{
}Details about any caps (minimum/maximum charges) that apply to a particular fee/charge
-
FeeType [
]- minItems 1
-
string
Fee/charge type which is being capped
ENUM: FEPF, FTOT, FYAF, FYAM, FYAQ, FYCP, FYDB, FYMI, FYXX
-
MinMaxType string
Min Max type
ENUM: FMMN, FMMX
-
FeeCapOccurrence integer
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
-
FeeCapAmount string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
Notes [
]-
string
Free text for adding extra details for fee charge cap
- minLength 1
- maxLength 2000
-
-
OtherFeeType [
]-
{
}Other fee type code which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
-
-
-
Repayment {
}Repayment details of the Loan product
-
RepaymentType string
Repayment type
ENUM: USBA, USBU, USCI, USCS, USER, USFA, USFB, USFI, USIO, USOT, USPF, USRW, USSL
-
RepaymentFrequency string
Repayment frequency
ENUM: SMDA, SMFL, SMFO, SMHY, SMMO, SMOT, SMQU, SMWE, SMYE
-
AmountType string
The repayment is for paying just the interest only or both interest and capital or bullet amount or balance to date etc
ENUM: RABD, RABL, RACI, RAFC, RAIO, RALT, USOT
-
Notes [
]-
string
Optional additional notes to supplement the Repayment
- minLength 1
- maxLength 2000
-
-
OtherRepaymentType {
}Other repayment type which is not in the standard code list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherRepaymentFrequency {
}Other repayment frequency which is not in the standard code list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherAmountType {
}Other amount type which is not in the standard code list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
RepaymentFeeCharges {
}Applicable fee/charges for repayment such as prepayment, full early repayment or non repayment.
-
RepaymentFeeChargeDetail [
]- minItems 1
-
{
}Details about specific fees/charges that are applied for repayment
-
FeeType string
Fee/Charge Type
ENUM: FEPF, FTOT, FYAF, FYAM, FYAQ, FYCP, FYDB, FYMI, FYXX
-
NegotiableIndicator boolean
Fee/charge which is usually negotiable rather than a fixed amount
-
FeeAmount string
Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate string
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType string
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
ENUM: INBB, INFR, INGR, INLR, INNE, INOT
-
ApplicationFrequency string
How frequently the fee/charge is applied to the account
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
CalculationFrequency string
How frequently the fee/charge is calculated
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
Notes [
]-
string
Optional additional notes to supplement the fee/charge details.
- minLength 1
- maxLength 2000
-
-
OtherFeeType {
}Other Fee/charge type which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
FeeCategory string
Categorisation of fees and charges into standard categories.
ENUM: FCOT, FCRE, FCSV
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType {
}Other fee rate type which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency {
}Other application frequencies not covered in the standard code list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency {
}Other calculation frequency which is not available in standard code set.
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
RepaymentFeeChargeCap [
]-
{
}RepaymentFeeChargeCap sets daily, weekly, monthly, yearly limits on the fees that are charged
-
FeeType [
]- minItems 1
-
string
Fee/charge type which is being capped
ENUM: FEPF, FTOT, FYAF, FYAM, FYAQ, FYCP, FYDB, FYMI, FYXX
-
MinMaxType string
Min Max type
ENUM: FMMN, FMMX
-
FeeCapOccurrence integer
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
-
FeeCapAmount string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: PACT, PDAY, PHYR, PMTH, PQTR, PWEK, PYER
-
Notes [
]-
string
Free text for adding extra details for fee charge cap
- minLength 1
- maxLength 2000
-
-
OtherFeeType [
]-
{
}Other fee type code which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
RepaymentHoliday [
]-
{
}Details of capital repayment holiday if any
-
MaxHolidayLength integer
The maximum length/duration of a Repayment Holiday
-
MaxHolidayPeriod string
The unit of period (days, weeks, months etc.) of the repayment holiday
ENUM: PACT, PDAY, PHYR, PMTH, PQTR, PWEK, PYER
-
Notes [
]-
string
Free text for adding details for repayment holiday
- minLength 1
- maxLength 2000
-
-
-
-
-
OtherFeesCharges [
]-
{
}Contains details of fees and charges which are not associated with either Overdraft or features/benefits
-
TariffType string
TariffType which defines the fee and charges.
ENUM: TTEL, TTMX, TTOT
-
TariffName string
Name of the tariff
- minLength 1
- maxLength 350
-
OtherTariffType {
}Other tariff type which is not in the standard list.
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
FeeChargeDetail [
]- minItems 1
-
{
}Other fees/charges details
-
FeeCategory string
Categorisation of fees and charges into standard categories.
ENUM: FCOT, FCRE, FCSV
-
FeeType string
Fee/Charge Type
ENUM: FEPF, FTOT, FYAF, FYAM, FYAQ, FYCP, FYDB, FYMI, FYXX
-
NegotiableIndicator boolean
Fee/charge which is usually negotiable rather than a fixed amount
-
FeeAmount string
Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate string
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType string
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
ENUM: INBB, INFR, INGR, INLR, INNE, INOT
-
ApplicationFrequency string
How frequently the fee/charge is applied to the account
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
CalculationFrequency string
How frequently the fee/charge is calculated
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
Notes [
]-
string
Optional additional notes to supplement the fee/charge details.
- minLength 1
- maxLength 2000
-
-
FeeChargeCap [
]-
{
}Details about any caps (maximum charges) that apply to a particular or group of fee/charge
-
FeeType [
]- minItems 1
-
string
Fee/charge type which is being capped
ENUM: FEPF, FTOT, FYAF, FYAM, FYAQ, FYCP, FYDB, FYMI, FYXX
-
MinMaxType string
Min Max type
ENUM: FMMN, FMMX
-
FeeCapOccurrence integer
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
-
FeeCapAmount string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: PACT, PDAY, PHYR, PMTH, PQTR, PWEK, PYER
-
Notes [
]-
string
Free text for adding extra details for fee charge cap
- minLength 1
- maxLength 2000
-
-
OtherFeeType [
]-
{
}Other fee type code which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OtherFeeCategoryType {
}-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeType {
}Other Fee/charge type which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
FeeCategory string
Categorisation of fees and charges into standard categories.
ENUM: FCOT, FCRE, FCSV
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType {
}Other fee rate type which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency {
}Other application frequencies not covered in the standard code list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency {
}Other calculation frequency which is not available in standard code set.
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
FeeApplicableRange {
}Range or amounts or rates for which the fee/charge applies
-
MinimumAmount string
Minimum Amount on which fee/charge is applicable (where it is expressed as an amount)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
MaximumAmount string
Maximum Amount on which fee is applicable (where it is expressed as an amount)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
MinimumRate string
Minimum rate on which fee/charge is applicable(where it is expressed as an rate)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
MaximumRate string
Maximum rate on which fee/charge is applicable(where it is expressed as an rate)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
-
-
FeeChargeCap [
]-
{
}Details about any caps (maximum charges) that apply to a particular or group of fee/charge
-
FeeType [
]- minItems 1
-
string
Fee/charge type which is being capped
ENUM: FEPF, FTOT, FYAF, FYAM, FYAQ, FYCP, FYDB, FYMI, FYXX
-
MinMaxType string
Min Max type
ENUM: FMMN, FMMX
-
FeeCapOccurrence integer
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
-
FeeCapAmount string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: PACT, PDAY, PHYR, PMTH, PQTR, PWEK, PYER
-
Notes [
]-
string
Free text for adding extra details for fee charge cap
- minLength 1
- maxLength 2000
-
-
OtherFeeType [
]-
{
}Other fee type code which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
-
-
BCA BCA {
}-
ProductDetails ProductDetails {
}-
Segment Segment [
]Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to BCA products, they are segmented in relation to different markets that they wish to focus on.
-
string
Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to BCA products, they are segmented in relation to different markets that they wish to focus on.
ENUM: ClientAccount, Standard, NonCommercialChaitiesClbSoc, NonCommercialPublicAuthGovt, Religious, SectorSpecific, Startup, Switcher
-
-
FeeFreeLength FeeFreeLength number
The length/duration of the fee free period
- format float
-
FeeFreeLengthPeriod FeeFreeLengthPeriod string
The unit of period (days, weeks, months etc.) of the promotional length
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Optional additional notes to supplement the Core product details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
-
CreditInterest CreditInterest {
}Details about the interest that may be payable to the BCA account holders
-
TierBandSet TierBandSet [
]The group of tiers or bands for which credit interest can be applied.
- minItems 1
-
{
}The group of tiers or bands for which credit interest can be applied.
-
TierBandMethod TierBandMethod string
The methodology of how credit interest is paid/applied. It can be:-
-
Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases.
-
Tiered Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance.
-
Whole The same interest rate is applied irrespective of the BCA balance
ENUM: Banded, Tiered, Whole
-
-
CalculationMethod CalculationMethod string
Methods of calculating interest
ENUM: Compound, SimpleInterest
-
Destination Destination string
Describes whether accrued interest is payable only to the BCA or to another bank account
ENUM: PayAway, SelfCredit
-
Notes Notes [
]Optional additional notes to supplement the Tier Band Set details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
TierBand TierBand [
]Tier Band Details
- minItems 1
-
{
}Tier Band Details
-
Identification Identification string
Unique and unambiguous identification of a Tier Band for a BCA.
- minLength 1
- maxLength 35
-
TierValueMinimum TierValueMinimum string
Minimum deposit value for which the credit interest tier applies.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
TierValueMaximum TierValueMaximum string
Maximum deposit value for which the credit interest tier applies.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CalculationFrequency CalculationFrequency string
How often is credit interest calculated for the account.
ENUM: Daily, HalfYearly, Monthly, Other, Quarterly, PerStatementDate, Weekly, Yearly
-
ApplicationFrequency ApplicationFrequency string
How often is interest applied to the BCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's BCA.
ENUM: Daily, HalfYearly, Monthly, Other, Quarterly, PerStatementDate, Weekly, Yearly
-
DepositInterestAppliedCoverage DepositInterestAppliedCoverage string
Amount on which Interest applied.
ENUM: Banded, Tiered, Whole
-
FixedVariableInterestRateType FixedVariableInterestRateType string
Type of interest rate, Fixed or Variable
ENUM: Fixed, Variable
-
AER AER string
The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
BankInterestRateType BankInterestRateType string
Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the BCA.
ENUM: Gross, Other
-
BankInterestRate BankInterestRate string
Bank Interest for the BCA product
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
Notes Notes [
]Optional additional notes to supplement the Tier Band details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherBankInterestType OtherBankInterestType {
}Other interest rate types which are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies that are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in the standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
Overdraft Overdraft {
}Borrowing details
-
Notes Notes [
]Associated Notes about the overdraft rates
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftTierBandSet OverdraftTierBandSet [
]Tier band set details
- minItems 1
-
{
}Tier band set details
-
TierBandMethod TierBandMethod string
The methodology of how overdraft is charged. It can be: 'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). 'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation 'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation.
ENUM: Banded, Tiered, Whole
-
OverdraftType OverdraftType string
An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time.
ENUM: Committed, OnDemand
-
Identification Identification string
Unique and unambiguous identification of a Tier Band for a overdraft product.
- minLength 1
- maxLength 35
-
AuthorisedIndicator AuthorisedIndicator boolean
Indicates if the Overdraft is authorised (Y) or unauthorised (N)
-
BufferAmount BufferAmount string
When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
Notes Notes [
]Optional additional notes to supplement the overdraft Tier Band Set details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftTierBand OverdraftTierBand [
]Provides overdraft details for a specific tier or band
- minItems 1
-
{
}Provides overdraft details for a specific tier or band
-
Identification Identification string
Unique and unambiguous identification of a Tier Band for a overdraft.
- minLength 1
- maxLength 35
-
TierValueMin TierValueMin string
Minimum value of Overdraft Tier/Band
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
TierValueMax TierValueMax string
Maximum value of Overdraft Tier/Band
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
EAR EAR string
EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft.
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
RepresentativeAPR RepresentativeAPR string
An annual percentage rate (APR) is the annual rate charged for borrowing or earned through an investment. APR is expressed as a percentage that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction but does not take compounding into account.
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
AgreementLengthMin AgreementLengthMin number
Specifies the minimum length of a band for a fixed overdraft agreement
- format float
-
AgreementLengthMax AgreementLengthMax number
Specifies the maximum length of a band for a fixed overdraft agreement
- format float
-
AgreementPeriod AgreementPeriod string
Specifies the period of a fixed length overdraft agreement
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
OverdraftInterestChargingCoverage OverdraftInterestChargingCoverage string
Refers to which interest rate is applied when interests are tiered. For example, if an overdraft balance is £2k and the interest tiers are:- 0-£500 0.1%, 500-1000 0.2%, 1000-10000 0.5%, then the applicable interest rate could either be 0.5% of the entire balance (since the account balance sits in the top interest tier) or (0.1% 500)+(0.2% 500)+(0.5%*1000). In the 1st situation, we say the interest is applied to the ‘Whole’ of the account balance, and in the 2nd that it is ‘Tiered’.
ENUM: Banded, Tiered, Whole
-
BankGuaranteedIndicator BankGuaranteedIndicator boolean
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
-
Notes Notes [
]Optional additional notes to supplement the Tier/band details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftFeesCharges OverdraftFeesCharges [
]Overdraft fees and charges
-
{
}Overdraft fees and charges
-
OverdraftFeeChargeCap OverdraftFeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, AnnualReview, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
MinMaxType MinMaxType string
Min Max type
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OverdraftFeeChargeDetail OverdraftFeeChargeDetail [
]Details about the fees/charges
- minItems 1
-
{
}Details about the fees/charges
-
FeeType FeeType string
Overdraft fee type
ENUM: ArrangedOverdraft, AnnualReview, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
NegotiableIndicator NegotiableIndicator boolean
Indicates whether fee and charges are negotiable
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not.
-
IncrementalBorrowingAmount IncrementalBorrowingAmount string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeAmount FeeAmount string
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate FeeRate string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType FeeRateType string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
ENUM: Gross, Other
-
ApplicationFrequency ApplicationFrequency string
Frequency at which the overdraft charge is applied to the account
ENUM: OnClosing, OnOpening, ChargingPeriod, Daily, PerItem, Monthly, OnAnniversary, Other, PerHundredPounds, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
CalculationFrequency CalculationFrequency string
How often is the overdraft fee/charge calculated for the account.
ENUM: OnClosing, OnOpening, ChargingPeriod, Daily, PerItem, Monthly, OnAnniversary, Other, PerHundredPounds, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
Notes Notes [
]Free text for capturing any other info related to Overdraft Fees Charge Details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftFeeChargeCap OverdraftFeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, AnnualReview, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
MinMaxType MinMaxType string
Min Max type
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OtherFeeType OtherFeeType {
}Other Fee type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType OtherFeeRateType {
}Other fee rate type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies that are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in the standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
OverdraftFeesCharges OverdraftFeesCharges [
]Overdraft fees and charges details
-
{
}Overdraft fees and charges details
-
OverdraftFeeChargeCap OverdraftFeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, AnnualReview, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
MinMaxType MinMaxType string
Min Max type
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OverdraftFeeChargeDetail OverdraftFeeChargeDetail [
]Details about the fees/charges
- minItems 1
-
{
}Details about the fees/charges
-
FeeType FeeType string
Overdraft fee type
ENUM: ArrangedOverdraft, AnnualReview, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
NegotiableIndicator NegotiableIndicator boolean
Indicates whether fee and charges are negotiable
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not.
-
IncrementalBorrowingAmount IncrementalBorrowingAmount string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeAmount FeeAmount string
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate FeeRate string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType FeeRateType string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
ENUM: Gross, Other
-
ApplicationFrequency ApplicationFrequency string
Frequency at which the overdraft charge is applied to the account
ENUM: OnClosing, OnOpening, ChargingPeriod, Daily, PerItem, Monthly, OnAnniversary, Other, PerHundredPounds, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
CalculationFrequency CalculationFrequency string
How often is the overdraft fee/charge calculated for the account.
ENUM: OnClosing, OnOpening, ChargingPeriod, Daily, PerItem, Monthly, OnAnniversary, Other, PerHundredPounds, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
Notes Notes [
]Free text for capturing any other info related to Overdraft Fees Charge Details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftFeeChargeCap OverdraftFeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, AnnualReview, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
MinMaxType MinMaxType string
Min Max type
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OtherFeeType OtherFeeType {
}Other Fee type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType OtherFeeRateType {
}Other fee rate type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies that are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in the standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
-
OtherFeesCharges OtherFeesCharges [
]Contains details of fees and charges which are not associated with either Overdraft or features/benefits
-
{
}Contains details of fees and charges which are not associated with either Overdraft or features/benefits
-
TariffType TariffType string
TariffType which defines the fee and charges.
ENUM: Electronic, Mixed, Other
-
TariffName TariffName string
Name of the tariff
- minLength 1
- maxLength 350
-
OtherTariffType OtherTariffType {
}Other tariff type which is not in the standard list.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
FeeChargeDetail FeeChargeDetail [
]Other fees/charges details
- minItems 1
-
{
}Other fees/charges details
-
FeeCategory FeeCategory string
Categorisation of fees and charges into standard categories.
ENUM: Other, Servicing
-
FeeType FeeType string
Fee/Charge Type
ENUM: Other, ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCAccountFeeQuarterly, ServiceCFixedTariff, ServiceCBusiDepAccBreakage, ServiceCMinimumMonthlyFee, ServiceCOther
-
NegotiableIndicator NegotiableIndicator boolean
Fee/charge which is usually negotiable rather than a fixed amount
-
FeeAmount FeeAmount string
Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate FeeRate string
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType FeeRateType string
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
ENUM: Gross, Other
-
ApplicationFrequency ApplicationFrequency string
How frequently the fee/charge is applied to the account
ENUM: OnClosing, OnOpening, ChargingPeriod, Daily, PerItem, Monthly, OnAnniversary, Other, PerHundredPounds, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
CalculationFrequency CalculationFrequency string
How frequently the fee/charge is calculated
ENUM: OnClosing, OnOpening, ChargingPeriod, Daily, PerItem, Monthly, OnAnniversary, Other, PerHundredPounds, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
Notes Notes [
]Optional additional notes to supplement the fee/charge details.
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
FeeChargeCap FeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular or group of fee/charge
-
{
}Details about any caps (maximum charges) that apply to a particular or group of fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Fee/charge type which is being capped
ENUM: Other, ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCAccountFeeQuarterly, ServiceCFixedTariff, ServiceCBusiDepAccBreakage, ServiceCMinimumMonthlyFee, ServiceCOther
-
MinMaxType MinMaxType string
Min Max type
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Free text for adding extra details for fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OtherFeeCategoryType OtherFeeCategoryType {
}-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeType OtherFeeType {
}Other Fee/charge type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
FeeCategory FeeCategory string
Categorisation of fees and charges into standard categories.
ENUM: Other, Servicing
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType OtherFeeRateType {
}Other fee rate type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies not covered in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
FeeApplicableRange FeeApplicableRange {
}Range or amounts or rates for which the fee/charge applies
-
MinimumAmount MinimumAmount string
Minimum Amount on which fee/charge is applicable (where it is expressed as an amount)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
MaximumAmount MaximumAmount string
Maximum Amount on which fee is applicable (where it is expressed as an amount)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
MinimumRate MinimumRate string
Minimum rate on which fee/charge is applicable(where it is expressed as an rate)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
MaximumRate MaximumRate string
Maximum rate on which fee/charge is applicable(where it is expressed as an rate)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
-
-
FeeChargeCap FeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular or group of fee/charge
-
{
}Details about any caps (maximum charges) that apply to a particular or group of fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Fee/charge type which is being capped
ENUM: Other, ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCAccountFeeQuarterly, ServiceCFixedTariff, ServiceCBusiDepAccBreakage, ServiceCMinimumMonthlyFee, ServiceCOther
-
MinMaxType MinMaxType string
Min Max type
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Free text for adding extra details for fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
-
-
PCA PCA {
}-
ProductDetails ProductDetails {
}-
Segment Segment [
]Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to PCA products, they are segmented in relation to different markets that they wish to focus on.
-
string
Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to PCA products, they are segmented in relation to different markets that they wish to focus on.
ENUM: Basic, BenefitAndReward, CreditInterest, Cashback, General, Graduate, Other, Overdraft, Packaged, Premium, Reward, Student, YoungAdult, Youth
-
-
MonthlyMaximumCharge MonthlyMaximumCharge string
The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
Notes Notes [
]Optional additional notes to supplement the Core product details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
-
CreditInterest CreditInterest {
}Details about the interest that may be payable to the PCA account holders
-
TierBandSet TierBandSet [
]The group of tiers or bands for which credit interest can be applied.
- minItems 1
-
{
}The group of tiers or bands for which credit interest can be applied.
-
TierBandMethod TierBandMethod string
The methodology of how credit interest is charged. It can be:-
-
Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases.
-
Tiered Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance.
-
Whole The same interest rate is applied irrespective of the PCA balance
ENUM: Tiered, Whole
-
-
CalculationMethod CalculationMethod string
Methods of calculating interest
ENUM: Compound, SimpleInterest
-
Destination Destination string
Describes whether accrued interest is payable only to the PCA or to another bank account
ENUM: PayAway, SelfCredit
-
Notes Notes [
]Optional additional notes to supplement the Tier Band Set details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
TierBand TierBand [
]Tier Band Details
- minItems 1
-
{
}Tier Band Details
-
Identification Identification string
Unique and unambiguous identification of a Tier Band for a PCA.
- minLength 1
- maxLength 35
-
TierValueMinimum TierValueMinimum string
Minimum deposit value for which the credit interest tier applies.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
TierValueMaximum TierValueMaximum string
Maximum deposit value for which the credit interest tier applies.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CalculationFrequency CalculationFrequency string
How often is credit interest calculated for the account.
ENUM: PerAcademicTerm, Daily, HalfYearly, Monthly, Other, Quarterly, PerStatementDate, Weekly, Yearly
-
ApplicationFrequency ApplicationFrequency string
How often is interest applied to the PCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's PCA.
ENUM: PerAcademicTerm, Daily, HalfYearly, Monthly, Other, Quarterly, PerStatementDate, Weekly, Yearly
-
DepositInterestAppliedCoverage DepositInterestAppliedCoverage string
Amount on which Interest applied.
ENUM: Tiered, Whole
-
FixedVariableInterestRateType FixedVariableInterestRateType string
Type of interest rate, Fixed or Variable
ENUM: Fixed, Variable
-
AER AER string
The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
BankInterestRateType BankInterestRateType string
Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the PCA.
ENUM: LinkedBaseRate, Gross, Net, Other
-
BankInterestRate BankInterestRate string
Bank Interest for the PCA product
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
Notes Notes [
]Optional additional notes to supplement the Tier Band details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherBankInterestType OtherBankInterestType {
}Other interest rate types which are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies that are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in the standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
Overdraft Overdraft {
}Details about Overdraft rates, fees & charges
-
Notes Notes [
]Associated Notes about the overdraft rates
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftTierBandSet OverdraftTierBandSet [
]Tier band set details
- minItems 1
-
{
}Tier band set details
-
TierBandMethod TierBandMethod string
The methodology of how overdraft is charged. It can be: 'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). 'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation 'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation.
ENUM: Tiered, Whole, Banded
-
OverdraftType OverdraftType string
An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time.
ENUM: Committed, OnDemand, Other
-
Identification Identification string
Unique and unambiguous identification of a Tier Band for a overdraft product.
- minLength 1
- maxLength 35
-
AuthorisedIndicator AuthorisedIndicator boolean
Indicates if the Overdraft is authorised (Y) or unauthorised (N)
-
BufferAmount BufferAmount string
When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
Notes Notes [
]Optional additional notes to supplement the overdraft Tier Band Set details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftTierBand OverdraftTierBand [
]Provides overdraft details for a specific tier or band
- minItems 1
-
{
}Provides overdraft details for a specific tier or band
-
Identification Identification string
Unique and unambiguous identification of a Tier Band for a overdraft.
- minLength 1
- maxLength 35
-
TierValueMin TierValueMin string
Minimum value of Overdraft Tier/Band
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
TierValueMax TierValueMax string
Maximum value of Overdraft Tier/Band
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
OverdraftInterestChargingCoverage OverdraftInterestChargingCoverage string
Interest charged on whole amount or tiered/banded
ENUM: Tiered, Whole
-
BankGuaranteedIndicator BankGuaranteedIndicator boolean
Indicates that a bank provides the overdraft limit up to TierValueMIn to all customers automatically
-
EAR EAR string
EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft.
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
RepresentativeAPR RepresentativeAPR string
An annual percentage rate (APR) is the annual rate charged for borrowing or earned through an investment. APR is expressed as a percentage that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction but does not take compounding into account.
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
Notes Notes [
]Optional additional notes to supplement the Tier/band details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OverdraftFeesCharges OverdraftFeesCharges [
]Overdraft fees and charges
-
{
}Overdraft fees and charges
-
OverdraftFeeChargeCap OverdraftFeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, AnnualReview, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Specifies for the overdraft control feature/benefit
-
MinMaxType MinMaxType string
Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: AcademicTerm, Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OverdraftFeeChargeDetail OverdraftFeeChargeDetail [
]Details about the fees/charges
- minItems 1
-
{
}Details about the fees/charges
-
FeeType FeeType string
Overdraft fee type
ENUM: ArrangedOverdraft, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, AnnualReview, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Specifies for the overdraft control feature/benefit
-
IncrementalBorrowingAmount IncrementalBorrowingAmount string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeAmount FeeAmount string
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate FeeRate string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType FeeRateType string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
ENUM: LinkedBaseRate, Gross, Net, Other
-
ApplicationFrequency ApplicationFrequency string
Frequency at which the overdraft charge is applied to the account
ENUM: AccountClosing, AccountOpening, AcademicTerm, ChargingPeriod, Daily, PerItem, Monthly, OnAccountAnniversary, Other, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
CalculationFrequency CalculationFrequency string
How often is the overdraft fee/charge calculated for the account.
ENUM: AccountClosing, AccountOpening, AcademicTerm, ChargingPeriod, Daily, PerItem, Monthly, OnAccountAnniversary, Other, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
Notes Notes [
]Free text for capturing any other info related to Overdraft Fees Charge Details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType {
}Other Fee type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType OtherFeeRateType {
}Other fee rate type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies that are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in the standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OverdraftFeeChargeCap OverdraftFeeChargeCap {
}Details about any caps (maximum charges) that apply to a particular fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, AnnualReview, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Specifies for the overdraft control feature/benefit
-
MinMaxType MinMaxType string
Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: AcademicTerm, Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
-
-
OverdraftFeesCharges OverdraftFeesCharges [
]Overdraft fees and charges details
-
{
}Overdraft fees and charges details
-
OverdraftFeeChargeCap OverdraftFeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, AnnualReview, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Specifies for the overdraft control feature/benefit
-
MinMaxType MinMaxType string
Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: AcademicTerm, Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
OverdraftFeeChargeDetail OverdraftFeeChargeDetail [
]Details about the fees/charges
- minItems 1
-
{
}Details about the fees/charges
-
FeeType FeeType string
Overdraft fee type
ENUM: ArrangedOverdraft, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, AnnualReview, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Specifies for the overdraft control feature/benefit
-
IncrementalBorrowingAmount IncrementalBorrowingAmount string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeAmount FeeAmount string
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate FeeRate string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType FeeRateType string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
ENUM: LinkedBaseRate, Gross, Net, Other
-
ApplicationFrequency ApplicationFrequency string
Frequency at which the overdraft charge is applied to the account
ENUM: AccountClosing, AccountOpening, AcademicTerm, ChargingPeriod, Daily, PerItem, Monthly, OnAccountAnniversary, Other, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
CalculationFrequency CalculationFrequency string
How often is the overdraft fee/charge calculated for the account.
ENUM: AccountClosing, AccountOpening, AcademicTerm, ChargingPeriod, Daily, PerItem, Monthly, OnAccountAnniversary, Other, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
Notes Notes [
]Free text for capturing any other info related to Overdraft Fees Charge Details
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType {
}Other Fee type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType OtherFeeRateType {
}Other fee rate type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies that are not available in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in the standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OverdraftFeeChargeCap OverdraftFeeChargeCap {
}Details about any caps (maximum charges) that apply to a particular fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Overdraft fee type
ENUM: ArrangedOverdraft, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, AnnualReview, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans
-
OverdraftControlIndicator OverdraftControlIndicator boolean
Specifies for the overdraft control feature/benefit
-
MinMaxType MinMaxType string
Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: AcademicTerm, Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Notes related to Overdraft fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
-
-
-
OtherFeesCharges OtherFeesCharges {
}Contains details of fees and charges which are not associated with either borrowing or features/benefits
-
FeeChargeDetail FeeChargeDetail [
]Other fees/charges details
- minItems 1
-
{
}Other fees/charges details
-
FeeCategory FeeCategory string
Categorisation of fees and charges into standard categories.
ENUM: Other, Servicing
-
FeeType FeeType string
Fee/Charge Type
ENUM: ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCOther, Other
-
FeeAmount FeeAmount string
Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
FeeRate FeeRate string
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
FeeRateType FeeRateType string
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
ENUM: LinkedBaseRate, Gross, Net, Other
-
ApplicationFrequency ApplicationFrequency string
How frequently the fee/charge is applied to the account
ENUM: AccountClosing, AccountOpening, AcademicTerm, ChargingPeriod, Daily, PerItem, Monthly, OnAccountAnniversary, Other, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
CalculationFrequency CalculationFrequency string
How frequently the fee/charge is calculated
ENUM: AccountClosing, AccountOpening, AcademicTerm, ChargingPeriod, Daily, PerItem, Monthly, OnAccountAnniversary, Other, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly
-
Notes Notes [
]Optional additional notes to supplement the fee/charge details.
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeCategoryType OtherFeeCategoryType {
}-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeType OtherFeeType {
}Other Fee/charge type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
FeeCategory FeeCategory string
Categorisation of fees and charges into standard categories.
ENUM: Other, Servicing
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherFeeRateType OtherFeeRateType {
}Other fee rate type which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherApplicationFrequency OtherApplicationFrequency {
}Other application frequencies not covered in the standard code list
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
OtherCalculationFrequency OtherCalculationFrequency {
}Other calculation frequency which is not available in standard code set.
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
FeeChargeCap FeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Fee/charge type which is being capped
ENUM: ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCOther, Other
-
MinMaxType MinMaxType string
Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: AcademicTerm, Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Free text for adding extra details for fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
FeeApplicableRange FeeApplicableRange {
}Range or amounts or rates for which the fee/charge applies
-
MinimumAmount MinimumAmount string
Minimum Amount on which fee/charge is applicable (where it is expressed as an amount)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
MaximumAmount MaximumAmount string
Maximum Amount on which fee is applicable (where it is expressed as an amount)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
MinimumRate MinimumRate string
Minimum rate on which fee/charge is applicable(where it is expressed as an rate)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
MaximumRate MaximumRate string
Maximum rate on which fee/charge is applicable(where it is expressed as an rate)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
-
-
FeeChargeCap FeeChargeCap [
]Details about any caps (maximum charges) that apply to a particular fee/charge
-
{
}Details about any caps (maximum charges) that apply to a particular fee/charge
-
FeeType FeeType [
]Fee/charge type which is being capped
- minItems 1
-
string
Fee/charge type which is being capped
ENUM: ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCOther, Other
-
MinMaxType MinMaxType string
Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution
ENUM: Minimum, Maximum
-
FeeCapOccurrence FeeCapOccurrence number
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
- format float
-
FeeCapAmount FeeCapAmount string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
CappingPeriod CappingPeriod string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: AcademicTerm, Day, Half Year, Month, Quarter, Week, Year
-
Notes Notes [
]Free text for adding extra details for fee charge cap
-
string
maxLength 2000 text
- minLength 1
- maxLength 2000
-
-
OtherFeeType OtherFeeType [
]Other fee type code which is not available in the standard code set
-
{
}Other fee type code which is not available in the standard code set
-
Code Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\w{0,4}$
- minLength 0
- maxLength 4
-
Name Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
-
-
-
-
-
-
-
-
Links {
}Links relevant to the payload
-
Self string
- format uri
-
First string
- format uri
-
Prev string
- format uri
-
Next string
- format uri
-
Last string
- format uri
-
-
Meta MetaData {
}Meta Data relevant to the payload
-
TotalPages integer
- format int32
-
FirstAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
LastAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
-
{
}-
Data {
}-
ScheduledPayment [
]-
OBScheduledPayment3 {
}-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
ScheduledPaymentId string
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
EXAMPLE: SP03- minLength 1
- maxLength 40
-
ScheduledPaymentDateTime string
The date on which the scheduled payment will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
ScheduledType string
Specifies the scheduled payment date type requested. For a full list of enumeration values refer to
OBInternalScheduleType1Codein OB_Internal_CodeSet hereENUM: Arrival, Execution
EXAMPLE: Arrival -
Reference string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
EXAMPLE: Towbar Club- minLength 1
- maxLength 35
-
DebtorReference string
A reference value provided by the PSU to the PISP while setting up the scheduled payment.
EXAMPLE: REF51561806- minLength 1
- maxLength 35
-
InstructedAmount {
}Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
CreditorAgent {
}Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
-
CreditorAccount {
}Provides the details to identify the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Beneficiary account identification.
- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
-
-
-
Links {
}Links relevant to the payload
-
Self string
- format uri
-
First string
- format uri
-
Prev string
- format uri
-
Next string
- format uri
-
Last string
- format uri
-
-
Meta MetaData {
}Meta Data relevant to the payload
-
TotalPages integer
- format int32
-
FirstAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
LastAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
-
{
}-
Data {
}-
StandingOrder [
]-
OBStandingOrder6 {
}-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
StandingOrderId string
A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.
EXAMPLE: Ben5- minLength 1
- maxLength 40
-
NextPaymentDateTime string
The date on which the next payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
LastPaymentDateTime string
The date on which the last (most recent) payment for a Standing Order schedule was made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
StandingOrderStatusCode string
Specifies the status of the standing order in code form. For a full list of enumeration values refer to 'ExternalMandateStatus1Code' in ISO_External_Codeset here
ENUM: ACTV, CANC, EXPI, SUSP
EXAMPLE: ACTV -
FirstPaymentAmount {
}The amount of the first Standing Order
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
NextPaymentAmount {
}The amount of the next Standing Order.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
LastPaymentAmount {
}The amount of the last (most recent) Standing Order instruction.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
FinalPaymentAmount {
}The amount of the final Standing Order
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
CreditorAgent {
}Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
-
CreditorAccount {
}Provides the details to identify the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Beneficiary account identification.
- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
MandateRelatedInformation {
}Provides further details of the mandate signed between the creditor and the debtor.
-
MandateIdentification string
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.
EXAMPLE: Golfers- minLength 1
- maxLength 35
-
FirstPaymentDateTime string
The date on which the first payment for a recurrent credit transfer will be made.
EXAMPLE: 2024-04-25T12:46:49.425Z- format date-time
-
FinalPaymentDateTime string
The date on which the final payment for a recurrent credit transfer will be made.
EXAMPLE: 2024-04-25T12:46:49.425Z- format date-time
-
Frequency {
}Regularity with which credit transfer instructions are to be created and processed
-
Type string
For a full list of values see
OBFrequency6Codein OB_Internal_CodeSet hereENUM: YEAR, FRTN, MNTH, QURT, MIAN, WEEK, FOWK, TWMH, FOMH
EXAMPLE: MNTH -
PointInTime string
Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or moment within a specified frequency type. Note: should not be used alongside
CountPerPeriod.EXAMPLE: 01- maxLength 2
-
-
-
-
-
-
Links {
}Links relevant to the payload
-
Self string
- format uri
-
First string
- format uri
-
Prev string
- format uri
-
Next string
- format uri
-
Last string
- format uri
-
-
Meta MetaData {
}Meta Data relevant to the payload
-
TotalPages integer
- format int32
-
FirstAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
LastAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
-
{
}-
Data {
}-
Statement [
]-
OBStatement2 {
}Provides further details on a statement resource.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
StatementId string
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
EXAMPLE: 8sfhke-sifhkeuf-97813- minLength 1
- maxLength 40
-
StatementReference string
Unique reference for the statement. This reference may be optionally populated if available.
EXAMPLE: 002- minLength 1
- maxLength 35
-
Type string
Statement type, in a coded form. For a full list of values see
OBInternalStatementType1Codein OB_Internal_CodeSet hereENUM: AccountClosure, AccountOpening, Annual, Interim, RegularPeriodic
EXAMPLE: RegularPeriodic -
StartDateTime string
Date and time at which the statement period starts. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
EndDateTime string
Date and time at which the statement period ends. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
CreationDateTime string
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2024-05-29T00:00:00Z- format date-time
-
StatementDescription [
]-
string
Other descriptions that may be available for the statement resource.
EXAMPLE: August 2017 Statement- minLength 1
- maxLength 500
-
-
StatementBenefit [
]-
{
}Set of elements used to provide details of a benefit or reward amount for the statement resource.
-
Type string
Benefit type, in a coded form. For a full list of values see
OBInternalStatementBenefitType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Cashback- x-namespaced-enum UK.OBIE.Cashback,UK.OBIE.Insurance,UK.OBIE.TravelDiscount,UK.OBIE.TravelInsurance
-
Amount {
}Amount of money associated with the statement benefit type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
StatementFee [
]-
{
}Set of elements used to provide details of a fee for the statement resource.
-
Description string
Description that may be available for the statement fee.
EXAMPLE: International usage charge- minLength 1
- maxLength 128
-
CreditDebitIndicator string
Indicates whether the amount is a credit or a debit. For a full list of values see
OBInternalCreditDebitCodein OB_Internal_CodeSet here
Usage: A zero amount is considered to be a credit amount.ENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Fee type, in a coded form. For a full list of values see
OBInternalStatementFeeType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Annual- x-namespaced-enum UK.OBIE.Annual,UK.OBIE.BalanceTransfer,UK.OBIE.CashAdvance,UK.OBIE.CashTransaction,UK.OBIE.ForeignCashTransaction,UK.OBIE.ForeignTransaction,UK.OBIE.Gambling,UK.OBIE.LatePayment,UK.OBIE.MoneyTransfer,UK.OBIE.Monthly,UK.OBIE.Overlimit,UK.OBIE.PostalOrder,UK.OBIE.PrizeEntry,UK.OBIE.StatementCopy,UK.OBIE.Total
-
Rate number
Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)
EXAMPLE: 0.05 -
RateType string
Description that may be available for the statement fee rate type. For a full list of values see
OBInternalStatementFeeRateType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.AER- x-namespaced-enum UK.OBIE.AER,UK.OBIE.EAR
-
Frequency string
How frequently the fee is applied to the Account. For a full list of values see
OBInternalStatementFeeFrequency1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.StatementMonthly- x-namespaced-enum UK.OBIE.ChargingPeriod,UK.OBIE.PerTransactionAmount,UK.OBIE.PerTransactionPercentage,UK.OBIE.Quarterly,UK.OBIE.StatementMonthly,UK.OBIE.Weekly
-
Amount {
}Amount of money associated with the statement fee type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
StatementInterest [
]-
{
}Set of elements used to provide details of a generic interest amount related to the statement resource.
-
Description string
Description that may be available for the statement interest.
EXAMPLE: Interest occurred over statement duration- minLength 1
- maxLength 128
-
CreditDebitIndicator string
Indicates whether the amount is a credit or a debit. For a full list of values see
OBInternalCreditDebitCodein OB_Internal_CodeSet here
Usage: A zero amount is considered to be a credit amount.ENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Interest amount type, in a coded form. For a full list of values see
OBInternalStatementInterestType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Total- x-namespaced-enum UK.OBIE.BalanceTransfer,UK.OBIE.Cash,UK.OBIE.EstimatedNext,UK.OBIE.Purchase,UK.OBIE.Total
-
Rate number
Rate for Statement Interest (where it is applicable in terms of a rate rather than an amount)
EXAMPLE: 0.05 -
RateType string
Interest amount type, in a coded form. For a full list of values see
OBInternalStatementInterestType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Total- x-namespaced-enum UK.OBIE.BalanceTransfer,UK.OBIE.Cash,UK.OBIE.EstimatedNext,UK.OBIE.Purchase,UK.OBIE.Total
-
Frequency string
Specifies the statement fee type requested. For a full list of values see
OBInternalStatementInterestFrequency1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Monthly- x-namespaced-enum UK.OBIE.Daily,UK.OBIE.HalfYearly,UK.OBIE.Monthly,UK.OBIE.PerStatementDate,UK.OBIE.Quarterly,UK.OBIE.Weekly,UK.OBIE.Yearly
-
Amount {
}Amount of money associated with the statement interest amount type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
StatementAmount [
]-
{
}Set of elements used to provide details of a generic amount for the statement resource.
-
CreditDebitIndicator string
Indicates whether the amount is a credit or a debit. For a full list of values see
OBInternalCreditDebitCodein OB_Internal_CodeSet here
Usage: A zero amount is considered to be a credit amount.ENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Amount type, in a coded form.
EXAMPLE: UK.OBIE.CreditLimit- x-namespaced-enum UK.OBIE.ArrearsClosingBalance,UK.OBIE.AvailableBalance,UK.OBIE.AverageBalanceWhenInCredit,UK.OBIE.AverageBalanceWhenInDebit,UK.OBIE.AverageDailyBalance,UK.OBIE.BalanceTransferClosingBalance,UK.OBIE.CashClosingBalance,UK.OBIE.ClosingBalance,UK.OBIE.CreditLimit,UK.OBIE.CurrentPayment,UK.OBIE.DirectDebitPaymentDue,UK.OBIE.FSCSInsurance,UK.OBIE.MinimumPaymentDue,UK.OBIE.PendingTransactionsBalance,UK.OBIE.PreviousClosingBalance,UK.OBIE.PreviousPayment,UK.OBIE.PurchaseClosingBalance,UK.OBIE.StartingBalance,UK.OBIE.TotalAdjustments,UK.OBIE.TotalCashAdvances,UK.OBIE.TotalCharges,UK.OBIE.TotalCredits,UK.OBIE.TotalDebits,UK.OBIE.TotalPurchases
-
Amount {
}Amount of money of the cash balance.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
SubType string
The amount in the domestic or base accounting currency. Default is Base Currency (BCUR) if not specified
ENUM: BCUR, LCUR
- default BCUR
-
-
LocalAmount {
}Optional component providing the equivalent of Amount in local currency.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
SubType string
The amount in the local market currency for which the asset is held. Default is Local Currency (LCUR) if not specified
ENUM: BCUR, LCUR
- default LCUR
-
-
-
-
StatementDateTime [
]-
{
}Set of elements used to provide details of a generic date time for the statement resource.
-
DateTime string
Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2024-05-29T00:00:00Z- format date-time
-
Type string
Date time type, in a coded form. For a full list of values see
OBInternalStatementDateTimeType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.NextStatement- x-namespaced-enum UK.OBIE.BalanceTransferPromoEnd,UK.OBIE.DirectDebitDue,UK.OBIE.LastPayment,UK.OBIE.LastStatement,UK.OBIE.NextStatement,UK.OBIE.PaymentDue,UK.OBIE.PurchasePromoEnd,UK.OBIE.StatementAvailable
-
-
-
StatementRate [
]-
{
}Set of elements used to provide details of a generic rate related to the statement resource.
-
Rate string
Rate associated with the statement rate type.
EXAMPLE: 0.224- maxLength 40
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
Type string
Statement rate type, in a coded form. For a full list of values see
OBInternalStatementRateType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.AnnualCash- x-namespaced-enum UK.OBIE.AnnualBalanceTransfer,UK.OBIE.AnnualBalanceTransferAfterPromo,UK.OBIE.AnnualBalanceTransferPromo,UK.OBIE.AnnualCash,UK.OBIE.AnnualPurchase,UK.OBIE.AnnualPurchaseAfterPromo,UK.OBIE.AnnualPurchasePromo,UK.OBIE.MonthlyBalanceTransfer,UK.OBIE.MonthlyCash,UK.OBIE.MonthlyPurchase
-
-
-
StatementValue [
]-
{
}Set of elements used to provide details of a generic number value related to the statement resource.
-
Value string
Value associated with the statement value type.
- minLength 1
- maxLength 40
-
Type string
Statement value type, in a coded form. For a full list of values see
OBInternalStatementValueType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Credit- x-namespaced-enum UK.OBIE.AirMilesPoints,UK.OBIE.AirMilesPointsBalance,UK.OBIE.Credits,UK.OBIE.Debits,UK.OBIE.HotelPoints,UK.OBIE.HotelPointsBalance,UK.OBIE.RetailShoppingPoints,UK.OBIE.RetailShoppingPointsBalance
-
-
-
TotalValue {
}Combined sum of all Amounts in the accounts base currency
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
-
Links {
}Links relevant to the payload
-
Self string
- format uri
-
First string
- format uri
-
Prev string
- format uri
-
Next string
- format uri
-
Last string
- format uri
-
-
Meta MetaData {
}Meta Data relevant to the payload
-
TotalPages integer
- format int32
-
FirstAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
LastAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
-
{
}-
Data {
}-
Transaction [
]-
OBTransaction6 {
}Provides further details on an entry in the report.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
TransactionId string
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
- minLength 1
- maxLength 210
-
TransactionReference string
Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
- minLength 1
- maxLength 210
-
StatementReference [
]-
StatementReference string
Unique reference for the statement. This reference may be optionally populated if available.
EXAMPLE: 002- minLength 1
- maxLength 35
-
-
CreditDebitIndicator string
Indicates whether the transaction is a credit or a debit entry.
For a full list of enumeration values refer toOBInternalCreditDebitCodein OB_Internal_CodeSet hereENUM: Credit, Debit
-
Status string
Status of a transaction entry on the books of the account servicer.
For a full list of enumeration values refer toExternalEntryStatus1Codein ISO_External_CodeSet hereENUM: BOOK, FUTR, INFO, PDNG
-
TransactionMutability string
Specifies the Mutability of the Transaction record.
For a full list of enumeration values refer toOBInternalTransactionMutability1Codein OB_Internal_CodeSet hereENUM: Mutable, Immutable
-
BookingDateTime string
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
ValueDateTime string
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
TransactionInformation string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
- minLength 1
- maxLength 500
-
AddressLine string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
- minLength 1
- maxLength 70
-
Amount {
}Amount of money in the cash transaction entry.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
ChargeAmount {
}Transaction charges to be paid by the charge bearer.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
CurrencyExchange {
}Set of elements used to provide details on the currency exchange.
-
SourceCurrency string
Currency from which an amount is to be converted in a currency conversion.
- pattern ^[A-Z]{3,3}$
-
TargetCurrency string
Currency into which an amount is to be converted in a currency conversion.
- pattern ^[A-Z]{3,3}$
-
UnitCurrency string
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
- pattern ^[A-Z]{3,3}$
-
ExchangeRate number
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).
-
ContractIdentification string
Unique identification to unambiguously identify the foreign exchange contract.
- minLength 1
- maxLength 35
-
QuotationDate string
Date and time at which an exchange rate is quoted. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
InstructedAmount {
}Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
BankTransactionCode {
}Set of elements used to fully identify the type of underlying transaction resulting in an entry.
-
Code string
Specifies the family within a domain.
-
SubCode string
Specifies the sub-product family within a specific family.
-
-
ProprietaryBankTransactionCode {
}Set of elements to fully identify a proprietary bank transaction code.
-
Code string
Proprietary bank transaction code to identify the underlying transaction.
- minLength 1
- maxLength 35
-
Issuer string
Identification of the issuer of the proprietary bank transaction code.
- minLength 1
- maxLength 35
-
-
ExtendedProprietaryBankTransactionCodes [
]-
OBExtendedProprietaryBankTransactionCode {
}Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction
-
Code string
Proprietary bank transaction code to identify the underlying transaction.
- minLength 1
- maxLength 35
-
Issuer string
Identification of the issuer of the proprietary bank transaction code.
- minLength 1
- maxLength 35
-
Description string
Description of the code and its usage on the ASPSP channel
- minLength 1
- maxLength 500
-
-
-
Balance {
}Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
-
CreditDebitIndicator string
Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.
For a full list of enumeration values refer toOBInternalCreditDebitCodein OB_Internal_CodeSet hereENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Balance type, in a coded form.
For a full list of enumeration values refer toExternalBalanceType1Codein ISO_External_CodeSet here .ENUM: CLAV, CLBD, FWAV, INFO, ITAV, ITBD, OPAV, OPBD, PRCD, XPCD
EXAMPLE: CLAV -
Amount {
}Amount of money of the cash balance after a transaction entry is applied to the account..
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
MerchantDetails {
}Details of the merchant involved in the transaction.
-
MerchantName string
Name by which the merchant is known.
- minLength 1
- maxLength 350
-
MerchantCategoryCode string
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
- minLength 3
- maxLength 4
-
MerchantCategory1Name string
Tier 1 Merchant Category Name
- minLength 1
- maxLength 255
-
MerchantCategory2Name string
Tier 2 Merchant Category Name
- minLength 1
- maxLength 255
-
MerchantCategory3Name string
Tier 3 Merchant Category Name
- minLength 1
- maxLength 255
-
FcaCode string
Financial Conduct Authority Code
- minLength 1
- maxLength 255
-
FcaCategory string
Financial Conduct Authority Category
- minLength 1
- maxLength 255
-
CarbonScore {
}Carbon emission scoring details
-
totalKgCo2e number
Total Kg of CO2 emitted
- minLength 1
- maxLength 350
-
carbonModelVersion string
Carbon Model Version
- minLength 1
- maxLength 350
-
-
-
CreditorAgent {
}Financial institution servicing an account for the creditor.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
CreditorAccount {
}Unambiguous identification of the account of the creditor, in the case of a debit transaction.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
DebtorAgent {
}Financial institution servicing an account for the debtor.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
DebtorAccount {
}Unambiguous identification of the account of the debtor, in the case of a crebit transaction.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
CardInstrument {
}Set of elements to describe the card instrument used in the transaction.
For a full list of enumeration values refer toOBInternalCardSchemeType1Codein OB_Internal_CodeSet here-
CardSchemeName string
Name of the card scheme.
For a full list of enumeration values refer toOBInternalCardSchemeType1Codein OB_Internal_CodeSet hereENUM: AmericanExpress, Diners, Discover, MasterCard, VISA
-
AuthorisationType string
The card authorisation type.
For a full list of enumeration values refer toOBInternalCardAuthorisationType1Codein OB_Internal_CodeSet hereENUM: ConsumerDevice, Contactless, None, PIN
-
Name string
Name of the cardholder using the card instrument.
- minLength 1
- maxLength 70
-
Identification string
Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked.
- minLength 1
- maxLength 34
-
-
CategoryPurposeCode string
Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see
ExternalCategoryPurpose1Codein ISO_External_CodeSet hereENUM: BONU, CASH, CBLK, CCRD, CGWV, CIPC, CONC, CORT, DCRD, DIVI, DVPM, EPAY, FCDT, FCIN, FCOL, GOVT, GP2P, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P, OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, SWEP, TAXS, TOPG, TRAD, TREA, VATX, VOST, WHLD, ZABA
-
PaymentPurposeCode string
For a full list of enumeration values refer to
ExternalPurpose1Codein ISO_External_CodeSet hereENUM: BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, INTP, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GIFT, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RRCT, RRTP, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, IPAY, IPCA, IPDO, IPEA, IPEC, IPEW, IPPS, IPRT, IPU2, IPUW, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SPSP, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER, BOND, CABD, CAEQ, CBCR, DBCR, DICL, EQTS, FLCR, EFTC, EFTD, MOMA, RAPI, GAMB, LOTT, AMEX, SASW, AUCO, PCOM, PDEP, PLDS, PLRF, GAFA, GAHO, CPEN, DEPD, RETL, DEBT
- minLength 1
- maxLength 4
-
UltimateCreditor {
}Ultimate party to which an amount of money is due.
-
Name string
Name by which a party is known and which is usually used to identify that party.
- minLength 1
- maxLength 140
-
Identification string
Identification assigned by an institution.
- minLength 1
- maxLength 256
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
UltimateDebtor {
}Ultimate party that owes an amount of money to the (ultimate) creditor.
-
Name string
Name by which a party is known and which is usually used to identify that party.
- minLength 1
- maxLength 140
-
Identification string
Identification assigned by an institution.
- minLength 1
- maxLength 256
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
-
-
-
Links {
}Links relevant to the payload
-
Self string
- format uri
-
First string
- format uri
-
Prev string
- format uri
-
Next string
- format uri
-
Last string
- format uri
-
-
Meta MetaData {
}Meta Data relevant to the payload
-
TotalPages integer
- format int32
-
FirstAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
LastAvailableDateTime string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
-
-
{
}-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
ScheduledPaymentId string
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
EXAMPLE: SP03- minLength 1
- maxLength 40
-
ScheduledPaymentDateTime string
The date on which the scheduled payment will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
ScheduledType string
Specifies the scheduled payment date type requested. For a full list of enumeration values refer to
OBInternalScheduleType1Codein OB_Internal_CodeSet hereENUM: Arrival, Execution
EXAMPLE: Arrival -
Reference string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
EXAMPLE: Towbar Club- minLength 1
- maxLength 35
-
DebtorReference string
A reference value provided by the PSU to the PISP while setting up the scheduled payment.
EXAMPLE: REF51561806- minLength 1
- maxLength 35
-
InstructedAmount {
}Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
CreditorAgent {
}Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
-
CreditorAccount {
}Provides the details to identify the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Beneficiary account identification.
- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
-
{
}-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
ScheduledPaymentId string
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
EXAMPLE: SP03- minLength 1
- maxLength 40
-
ScheduledPaymentDateTime string
The date on which the scheduled payment will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
ScheduledType string
Specifies the scheduled payment date type requested. For a full list of enumeration values refer to
OBInternalScheduleType1Codein OB_Internal_CodeSet hereENUM: Arrival, Execution
EXAMPLE: Arrival -
Reference string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
EXAMPLE: Towbar Club- minLength 1
- maxLength 35
-
DebtorReference string
A reference value provided by the PSU to the PISP while setting up the scheduled payment.
EXAMPLE: REF51561806- minLength 1
- maxLength 35
-
InstructedAmount {
}Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
{
}-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
ScheduledPaymentId string
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
EXAMPLE: SP03- minLength 1
- maxLength 40
-
ScheduledPaymentDateTime string
The date on which the scheduled payment will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
ScheduledType string
Specifies the scheduled payment date type requested. For a full list of enumeration values refer to
OBInternalScheduleType1Codein OB_Internal_CodeSet hereENUM: Arrival, Execution
EXAMPLE: Arrival -
Reference string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
EXAMPLE: Towbar Club- minLength 1
- maxLength 35
-
DebtorReference string
A reference value provided by the PSU to the PISP while setting up the scheduled payment.
EXAMPLE: REF51561806- minLength 1
- maxLength 35
-
InstructedAmount {
}Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
CreditorAgent {
}Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
-
CreditorAccount {
}Provides the details to identify the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Beneficiary account identification.
- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
-
{
}-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
StandingOrderId string
A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.
EXAMPLE: Ben5- minLength 1
- maxLength 40
-
NextPaymentDateTime string
The date on which the next payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
LastPaymentDateTime string
The date on which the last (most recent) payment for a Standing Order schedule was made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
StandingOrderStatusCode string
Specifies the status of the standing order in code form. For a full list of enumeration values refer to 'ExternalMandateStatus1Code' in ISO_External_Codeset here
ENUM: ACTV, CANC, EXPI, SUSP
EXAMPLE: ACTV -
FirstPaymentAmount {
}The amount of the first Standing Order
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
NextPaymentAmount {
}The amount of the next Standing Order.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
LastPaymentAmount {
}The amount of the last (most recent) Standing Order instruction.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
FinalPaymentAmount {
}The amount of the final Standing Order
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
CreditorAgent {
}Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
-
CreditorAccount {
}Provides the details to identify the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Beneficiary account identification.
- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
MandateRelatedInformation {
}Provides further details of the mandate signed between the creditor and the debtor.
-
MandateIdentification string
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.
EXAMPLE: Golfers- minLength 1
- maxLength 35
-
FirstPaymentDateTime string
The date on which the first payment for a recurrent credit transfer will be made.
EXAMPLE: 2024-04-25T12:46:49.425Z- format date-time
-
FinalPaymentDateTime string
The date on which the final payment for a recurrent credit transfer will be made.
EXAMPLE: 2024-04-25T12:46:49.425Z- format date-time
-
Frequency {
}Regularity with which credit transfer instructions are to be created and processed
-
Type string
For a full list of values see
OBFrequency6Codein OB_Internal_CodeSet hereENUM: YEAR, FRTN, MNTH, QURT, MIAN, WEEK, FOWK, TWMH, FOMH
EXAMPLE: MNTH -
PointInTime string
Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or moment within a specified frequency type. Note: should not be used alongside
CountPerPeriod.EXAMPLE: 01- maxLength 2
-
-
-
-
{
}-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
StandingOrderId string
A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.
EXAMPLE: Ben5- minLength 1
- maxLength 40
-
NextPaymentDateTime string
The date on which the next payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
LastPaymentDateTime string
The date on which the last (most recent) payment for a Standing Order schedule was made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
StandingOrderStatusCode string
Specifies the status of the standing order in code form. For a full list of enumeration values refer to 'ExternalMandateStatus1Code' in ISO_External_Codeset here
ENUM: ACTV, CANC, EXPI, SUSP
EXAMPLE: ACTV -
FirstPaymentAmount {
}The amount of the first Standing Order
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
NextPaymentAmount {
}The amount of the next Standing Order.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
LastPaymentAmount {
}The amount of the last (most recent) Standing Order instruction.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
FinalPaymentAmount {
}The amount of the final Standing Order
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
MandateRelatedInformation {
}Provides further details of the mandate signed between the creditor and the debtor.
-
MandateIdentification string
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.
EXAMPLE: Golfers- minLength 1
- maxLength 35
-
FirstPaymentDateTime string
The date on which the first payment for a recurrent credit transfer will be made.
EXAMPLE: 2024-04-25T12:46:49.425Z- format date-time
-
FinalPaymentDateTime string
The date on which the final payment for a recurrent credit transfer will be made.
EXAMPLE: 2024-04-25T12:46:49.425Z- format date-time
-
Frequency {
}Regularity with which credit transfer instructions are to be created and processed
-
Type string
For a full list of values see
OBFrequency6Codein OB_Internal_CodeSet hereENUM: YEAR, FRTN, MNTH, QURT, MIAN, WEEK, FOWK, TWMH, FOMH
EXAMPLE: MNTH -
PointInTime string
Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or moment within a specified frequency type. Note: should not be used alongside
CountPerPeriod.EXAMPLE: 01- maxLength 2
-
-
-
-
{
}-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
StandingOrderId string
A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.
EXAMPLE: Ben5- minLength 1
- maxLength 40
-
NextPaymentDateTime string
The date on which the next payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
LastPaymentDateTime string
The date on which the last (most recent) payment for a Standing Order schedule was made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
StandingOrderStatusCode string
Specifies the status of the standing order in code form. For a full list of enumeration values refer to 'ExternalMandateStatus1Code' in ISO_External_Codeset here
ENUM: ACTV, CANC, EXPI, SUSP
EXAMPLE: ACTV -
FirstPaymentAmount {
}The amount of the first Standing Order
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
NextPaymentAmount {
}The amount of the next Standing Order.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
LastPaymentAmount {
}The amount of the last (most recent) Standing Order instruction.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
FinalPaymentAmount {
}The amount of the final Standing Order
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
CreditorAgent {
}Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of the servicing institution.
EXAMPLE: 80200112344562- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
-
CreditorAccount {
}Provides the details to identify the beneficiary account.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Beneficiary account identification.
- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
MandateRelatedInformation {
}Provides further details of the mandate signed between the creditor and the debtor.
-
MandateIdentification string
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.
EXAMPLE: Golfers- minLength 1
- maxLength 35
-
FirstPaymentDateTime string
The date on which the first payment for a recurrent credit transfer will be made.
EXAMPLE: 2024-04-25T12:46:49.425Z- format date-time
-
FinalPaymentDateTime string
The date on which the final payment for a recurrent credit transfer will be made.
EXAMPLE: 2024-04-25T12:46:49.425Z- format date-time
-
Frequency {
}Regularity with which credit transfer instructions are to be created and processed
-
Type string
For a full list of values see
OBFrequency6Codein OB_Internal_CodeSet hereENUM: YEAR, FRTN, MNTH, QURT, MIAN, WEEK, FOWK, TWMH, FOMH
EXAMPLE: MNTH -
PointInTime string
Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or moment within a specified frequency type. Note: should not be used alongside
CountPerPeriod.EXAMPLE: 01- maxLength 2
-
-
-
-
{
}Provides further details on a statement resource.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
StatementId string
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
EXAMPLE: 8sfhke-sifhkeuf-97813- minLength 1
- maxLength 40
-
StatementReference string
Unique reference for the statement. This reference may be optionally populated if available.
EXAMPLE: 002- minLength 1
- maxLength 35
-
Type string
Statement type, in a coded form. For a full list of values see
OBInternalStatementType1Codein OB_Internal_CodeSet hereENUM: AccountClosure, AccountOpening, Annual, Interim, RegularPeriodic
EXAMPLE: RegularPeriodic -
StartDateTime string
Date and time at which the statement period starts. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
EndDateTime string
Date and time at which the statement period ends. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
CreationDateTime string
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2024-05-29T00:00:00Z- format date-time
-
StatementDescription [
]-
string
Other descriptions that may be available for the statement resource.
EXAMPLE: August 2017 Statement- minLength 1
- maxLength 500
-
-
StatementBenefit [
]-
{
}Set of elements used to provide details of a benefit or reward amount for the statement resource.
-
Type string
Benefit type, in a coded form. For a full list of values see
OBInternalStatementBenefitType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Cashback- x-namespaced-enum UK.OBIE.Cashback,UK.OBIE.Insurance,UK.OBIE.TravelDiscount,UK.OBIE.TravelInsurance
-
Amount {
}Amount of money associated with the statement benefit type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
StatementFee [
]-
{
}Set of elements used to provide details of a fee for the statement resource.
-
Description string
Description that may be available for the statement fee.
EXAMPLE: International usage charge- minLength 1
- maxLength 128
-
CreditDebitIndicator string
Indicates whether the amount is a credit or a debit. For a full list of values see
OBInternalCreditDebitCodein OB_Internal_CodeSet here
Usage: A zero amount is considered to be a credit amount.ENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Fee type, in a coded form. For a full list of values see
OBInternalStatementFeeType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Annual- x-namespaced-enum UK.OBIE.Annual,UK.OBIE.BalanceTransfer,UK.OBIE.CashAdvance,UK.OBIE.CashTransaction,UK.OBIE.ForeignCashTransaction,UK.OBIE.ForeignTransaction,UK.OBIE.Gambling,UK.OBIE.LatePayment,UK.OBIE.MoneyTransfer,UK.OBIE.Monthly,UK.OBIE.Overlimit,UK.OBIE.PostalOrder,UK.OBIE.PrizeEntry,UK.OBIE.StatementCopy,UK.OBIE.Total
-
Rate number
Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)
EXAMPLE: 0.05 -
RateType string
Description that may be available for the statement fee rate type. For a full list of values see
OBInternalStatementFeeRateType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.AER- x-namespaced-enum UK.OBIE.AER,UK.OBIE.EAR
-
Frequency string
How frequently the fee is applied to the Account. For a full list of values see
OBInternalStatementFeeFrequency1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.StatementMonthly- x-namespaced-enum UK.OBIE.ChargingPeriod,UK.OBIE.PerTransactionAmount,UK.OBIE.PerTransactionPercentage,UK.OBIE.Quarterly,UK.OBIE.StatementMonthly,UK.OBIE.Weekly
-
Amount {
}Amount of money associated with the statement fee type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
StatementInterest [
]-
{
}Set of elements used to provide details of a generic interest amount related to the statement resource.
-
Description string
Description that may be available for the statement interest.
EXAMPLE: Interest occurred over statement duration- minLength 1
- maxLength 128
-
CreditDebitIndicator string
Indicates whether the amount is a credit or a debit. For a full list of values see
OBInternalCreditDebitCodein OB_Internal_CodeSet here
Usage: A zero amount is considered to be a credit amount.ENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Interest amount type, in a coded form. For a full list of values see
OBInternalStatementInterestType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Total- x-namespaced-enum UK.OBIE.BalanceTransfer,UK.OBIE.Cash,UK.OBIE.EstimatedNext,UK.OBIE.Purchase,UK.OBIE.Total
-
Rate number
Rate for Statement Interest (where it is applicable in terms of a rate rather than an amount)
EXAMPLE: 0.05 -
RateType string
Interest amount type, in a coded form. For a full list of values see
OBInternalStatementInterestType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Total- x-namespaced-enum UK.OBIE.BalanceTransfer,UK.OBIE.Cash,UK.OBIE.EstimatedNext,UK.OBIE.Purchase,UK.OBIE.Total
-
Frequency string
Specifies the statement fee type requested. For a full list of values see
OBInternalStatementInterestFrequency1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Monthly- x-namespaced-enum UK.OBIE.Daily,UK.OBIE.HalfYearly,UK.OBIE.Monthly,UK.OBIE.PerStatementDate,UK.OBIE.Quarterly,UK.OBIE.Weekly,UK.OBIE.Yearly
-
Amount {
}Amount of money associated with the statement interest amount type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
StatementAmount [
]-
{
}Set of elements used to provide details of a generic amount for the statement resource.
-
CreditDebitIndicator string
Indicates whether the amount is a credit or a debit. For a full list of values see
OBInternalCreditDebitCodein OB_Internal_CodeSet here
Usage: A zero amount is considered to be a credit amount.ENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Amount type, in a coded form.
EXAMPLE: UK.OBIE.CreditLimit- x-namespaced-enum UK.OBIE.ArrearsClosingBalance,UK.OBIE.AvailableBalance,UK.OBIE.AverageBalanceWhenInCredit,UK.OBIE.AverageBalanceWhenInDebit,UK.OBIE.AverageDailyBalance,UK.OBIE.BalanceTransferClosingBalance,UK.OBIE.CashClosingBalance,UK.OBIE.ClosingBalance,UK.OBIE.CreditLimit,UK.OBIE.CurrentPayment,UK.OBIE.DirectDebitPaymentDue,UK.OBIE.FSCSInsurance,UK.OBIE.MinimumPaymentDue,UK.OBIE.PendingTransactionsBalance,UK.OBIE.PreviousClosingBalance,UK.OBIE.PreviousPayment,UK.OBIE.PurchaseClosingBalance,UK.OBIE.StartingBalance,UK.OBIE.TotalAdjustments,UK.OBIE.TotalCashAdvances,UK.OBIE.TotalCharges,UK.OBIE.TotalCredits,UK.OBIE.TotalDebits,UK.OBIE.TotalPurchases
-
Amount {
}Amount of money of the cash balance.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
SubType string
The amount in the domestic or base accounting currency. Default is Base Currency (BCUR) if not specified
ENUM: BCUR, LCUR
- default BCUR
-
-
LocalAmount {
}Optional component providing the equivalent of Amount in local currency.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
SubType string
The amount in the local market currency for which the asset is held. Default is Local Currency (LCUR) if not specified
ENUM: BCUR, LCUR
- default LCUR
-
-
-
-
StatementDateTime [
]-
{
}Set of elements used to provide details of a generic date time for the statement resource.
-
DateTime string
Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2024-05-29T00:00:00Z- format date-time
-
Type string
Date time type, in a coded form. For a full list of values see
OBInternalStatementDateTimeType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.NextStatement- x-namespaced-enum UK.OBIE.BalanceTransferPromoEnd,UK.OBIE.DirectDebitDue,UK.OBIE.LastPayment,UK.OBIE.LastStatement,UK.OBIE.NextStatement,UK.OBIE.PaymentDue,UK.OBIE.PurchasePromoEnd,UK.OBIE.StatementAvailable
-
-
-
StatementRate [
]-
{
}Set of elements used to provide details of a generic rate related to the statement resource.
-
Rate string
Rate associated with the statement rate type.
EXAMPLE: 0.224- maxLength 40
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
Type string
Statement rate type, in a coded form. For a full list of values see
OBInternalStatementRateType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.AnnualCash- x-namespaced-enum UK.OBIE.AnnualBalanceTransfer,UK.OBIE.AnnualBalanceTransferAfterPromo,UK.OBIE.AnnualBalanceTransferPromo,UK.OBIE.AnnualCash,UK.OBIE.AnnualPurchase,UK.OBIE.AnnualPurchaseAfterPromo,UK.OBIE.AnnualPurchasePromo,UK.OBIE.MonthlyBalanceTransfer,UK.OBIE.MonthlyCash,UK.OBIE.MonthlyPurchase
-
-
-
StatementValue [
]-
{
}Set of elements used to provide details of a generic number value related to the statement resource.
-
Value string
Value associated with the statement value type.
- minLength 1
- maxLength 40
-
Type string
Statement value type, in a coded form. For a full list of values see
OBInternalStatementValueType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Credit- x-namespaced-enum UK.OBIE.AirMilesPoints,UK.OBIE.AirMilesPointsBalance,UK.OBIE.Credits,UK.OBIE.Debits,UK.OBIE.HotelPoints,UK.OBIE.HotelPointsBalance,UK.OBIE.RetailShoppingPoints,UK.OBIE.RetailShoppingPointsBalance
-
-
-
TotalValue {
}Combined sum of all Amounts in the accounts base currency
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
{
}Provides further details on a statement resource.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
StatementId string
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
EXAMPLE: 8sfhke-sifhkeuf-97813- minLength 1
- maxLength 40
-
StatementReference string
Unique reference for the statement. This reference may be optionally populated if available.
EXAMPLE: 002- minLength 1
- maxLength 35
-
Type string
Statement type, in a coded form. For a full list of values see
OBInternalStatementType1Codein OB_Internal_CodeSet hereENUM: AccountClosure, AccountOpening, Annual, Interim, RegularPeriodic
EXAMPLE: RegularPeriodic -
StartDateTime string
Date and time at which the statement period starts. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
EndDateTime string
Date and time at which the statement period ends. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
CreationDateTime string
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2024-05-29T00:00:00Z- format date-time
-
StatementDescription [
]-
string
Other descriptions that may be available for the statement resource.
- minLength 1
- maxLength 500
-
-
StatementBenefit [
]-
{
}Set of elements used to provide details of a benefit or reward amount for the statement resource.
-
Type string
Benefit type, in a coded form. For a full list of values see
OBInternalStatementBenefitType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Cashback- x-namespaced-enum UK.OBIE.Cashback,UK.OBIE.Insurance,UK.OBIE.TravelDiscount,UK.OBIE.TravelInsurance
-
Amount {
}Amount of money associated with the statement benefit type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
StatementFee [
]-
{
}Set of elements used to provide details of a fee for the statement resource.
-
Description string
Description that may be available for the statement fee.
EXAMPLE: International usage charge- minLength 1
- maxLength 128
-
CreditDebitIndicator string
Indicates whether the amount is a credit or a debit. For a full list of values see
OBInternalCreditDebitCodein OB_Internal_CodeSet here
Usage: A zero amount is considered to be a credit amount.ENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Fee type, in a coded form. For a full list of values see
OBInternalStatementFeeType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Annual- x-namespaced-enum UK.OBIE.Annual,UK.OBIE.BalanceTransfer,UK.OBIE.CashAdvance,UK.OBIE.CashTransaction,UK.OBIE.ForeignCashTransaction,UK.OBIE.ForeignTransaction,UK.OBIE.Gambling,UK.OBIE.LatePayment,UK.OBIE.MoneyTransfer,UK.OBIE.Monthly,UK.OBIE.Overlimit,UK.OBIE.PostalOrder,UK.OBIE.PrizeEntry,UK.OBIE.StatementCopy,UK.OBIE.Total
-
Rate number
Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)
EXAMPLE: 0.05 -
RateType string
Description that may be available for the statement fee rate type. For a full list of values see
OBInternalStatementFeeRateType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.AER- x-namespaced-enum UK.OBIE.AER,UK.OBIE.EAR
-
Frequency string
How frequently the fee is applied to the Account. For a full list of values see
OBInternalStatementFeeFrequency1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.StatementMonthly- x-namespaced-enum UK.OBIE.ChargingPeriod,UK.OBIE.PerTransactionAmount,UK.OBIE.PerTransactionPercentage,UK.OBIE.Quarterly,UK.OBIE.StatementMonthly,UK.OBIE.Weekly
-
Amount {
}Amount of money associated with the statement fee type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
StatementInterest [
]-
{
}Set of elements used to provide details of a generic interest amount related to the statement resource.
-
Description string
Description that may be available for the statement interest.
EXAMPLE: Interest occurred over statement duration- minLength 1
- maxLength 128
-
CreditDebitIndicator string
Indicates whether the amount is a credit or a debit. For a full list of values see
OBInternalCreditDebitCodein OB_Internal_CodeSet here
Usage: A zero amount is considered to be a credit amount.ENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Interest amount type, in a coded form. For a full list of values see
OBInternalStatementInterestType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Total- x-namespaced-enum UK.OBIE.BalanceTransfer,UK.OBIE.Cash,UK.OBIE.EstimatedNext,UK.OBIE.Purchase,UK.OBIE.Total
-
Rate number
Rate for Statement Interest (where it is applicable in terms of a rate rather than an amount)
EXAMPLE: 0.05 -
RateType string
Interest amount type, in a coded form. For a full list of values see
OBInternalStatementInterestType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Total- x-namespaced-enum UK.OBIE.BalanceTransfer,UK.OBIE.Cash,UK.OBIE.EstimatedNext,UK.OBIE.Purchase,UK.OBIE.Total
-
Frequency string
Specifies the statement fee type requested. For a full list of values see
OBInternalStatementInterestFrequency1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Monthly- x-namespaced-enum UK.OBIE.Daily,UK.OBIE.HalfYearly,UK.OBIE.Monthly,UK.OBIE.PerStatementDate,UK.OBIE.Quarterly,UK.OBIE.Weekly,UK.OBIE.Yearly
-
Amount {
}Amount of money associated with the statement interest amount type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
StatementDateTime [
]-
{
}Set of elements used to provide details of a generic date time for the statement resource.
-
DateTime string
Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2024-05-29T00:00:00Z- format date-time
-
Type string
Date time type, in a coded form. For a full list of values see
OBInternalStatementDateTimeType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.NextStatement- x-namespaced-enum UK.OBIE.BalanceTransferPromoEnd,UK.OBIE.DirectDebitDue,UK.OBIE.LastPayment,UK.OBIE.LastStatement,UK.OBIE.NextStatement,UK.OBIE.PaymentDue,UK.OBIE.PurchasePromoEnd,UK.OBIE.StatementAvailable
-
-
-
StatementRate [
]-
{
}Set of elements used to provide details of a generic rate related to the statement resource.
-
Rate string
Rate associated with the statement rate type.
EXAMPLE: 0.224- maxLength 40
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
Type string
Statement rate type, in a coded form. For a full list of values see
OBInternalStatementRateType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.AnnualCash- x-namespaced-enum UK.OBIE.AnnualBalanceTransfer,UK.OBIE.AnnualBalanceTransferAfterPromo,UK.OBIE.AnnualBalanceTransferPromo,UK.OBIE.AnnualCash,UK.OBIE.AnnualPurchase,UK.OBIE.AnnualPurchaseAfterPromo,UK.OBIE.AnnualPurchasePromo,UK.OBIE.MonthlyBalanceTransfer,UK.OBIE.MonthlyCash,UK.OBIE.MonthlyPurchase
-
-
-
StatementValue [
]-
{
}Set of elements used to provide details of a generic number value related to the statement resource.
-
Value string
Value associated with the statement value type.
- minLength 1
- maxLength 40
-
Type string
Statement value type, in a coded form. For a full list of values see
OBInternalStatementValueType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Credit- x-namespaced-enum UK.OBIE.AirMilesPoints,UK.OBIE.AirMilesPointsBalance,UK.OBIE.Credits,UK.OBIE.Debits,UK.OBIE.HotelPoints,UK.OBIE.HotelPointsBalance,UK.OBIE.RetailShoppingPoints,UK.OBIE.RetailShoppingPointsBalance
-
-
-
TotalValue {
}Combined sum of all Amounts in the accounts base currency
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
{
}Provides further details on a statement resource.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
StatementId string
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
EXAMPLE: 8sfhke-sifhkeuf-97813- minLength 1
- maxLength 40
-
StatementReference string
Unique reference for the statement. This reference may be optionally populated if available.
EXAMPLE: 002- minLength 1
- maxLength 35
-
Type string
Statement type, in a coded form. For a full list of values see
OBInternalStatementType1Codein OB_Internal_CodeSet hereENUM: AccountClosure, AccountOpening, Annual, Interim, RegularPeriodic
EXAMPLE: RegularPeriodic -
StartDateTime string
Date and time at which the statement period starts. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
EndDateTime string
Date and time at which the statement period ends. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
CreationDateTime string
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2024-05-29T00:00:00Z- format date-time
-
StatementDescription [
]-
string
Other descriptions that may be available for the statement resource.
- minLength 1
- maxLength 500
-
-
StatementBenefit [
]-
{
}Set of elements used to provide details of a benefit or reward amount for the statement resource.
-
Type string
Benefit type, in a coded form. For a full list of values see
OBInternalStatementBenefitType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Cashback- x-namespaced-enum UK.OBIE.Cashback,UK.OBIE.Insurance,UK.OBIE.TravelDiscount,UK.OBIE.TravelInsurance
-
Amount {
}Amount of money associated with the statement benefit type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
StatementFee [
]-
{
}Set of elements used to provide details of a fee for the statement resource.
-
Description string
Description that may be available for the statement fee.
EXAMPLE: International usage charge- minLength 1
- maxLength 128
-
CreditDebitIndicator string
Indicates whether the amount is a credit or a debit. For a full list of values see
OBInternalCreditDebitCodein OB_Internal_CodeSet here
Usage: A zero amount is considered to be a credit amount.ENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Fee type, in a coded form. For a full list of values see
OBInternalStatementFeeType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Annual- x-namespaced-enum UK.OBIE.Annual,UK.OBIE.BalanceTransfer,UK.OBIE.CashAdvance,UK.OBIE.CashTransaction,UK.OBIE.ForeignCashTransaction,UK.OBIE.ForeignTransaction,UK.OBIE.Gambling,UK.OBIE.LatePayment,UK.OBIE.MoneyTransfer,UK.OBIE.Monthly,UK.OBIE.Overlimit,UK.OBIE.PostalOrder,UK.OBIE.PrizeEntry,UK.OBIE.StatementCopy,UK.OBIE.Total
-
Rate number
Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)
EXAMPLE: 0.05 -
RateType string
Description that may be available for the statement fee rate type. For a full list of values see
OBInternalStatementFeeRateType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.AER- x-namespaced-enum UK.OBIE.AER,UK.OBIE.EAR
-
Frequency string
How frequently the fee is applied to the Account. For a full list of values see
OBInternalStatementFeeFrequency1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.StatementMonthly- x-namespaced-enum UK.OBIE.ChargingPeriod,UK.OBIE.PerTransactionAmount,UK.OBIE.PerTransactionPercentage,UK.OBIE.Quarterly,UK.OBIE.StatementMonthly,UK.OBIE.Weekly
-
Amount {
}Amount of money associated with the statement fee type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
StatementInterest [
]-
{
}Set of elements used to provide details of a generic interest amount related to the statement resource.
-
Description string
Description that may be available for the statement interest.
EXAMPLE: Interest occurred over statement duration- minLength 1
- maxLength 128
-
CreditDebitIndicator string
Indicates whether the amount is a credit or a debit. For a full list of values see
OBInternalCreditDebitCodein OB_Internal_CodeSet here
Usage: A zero amount is considered to be a credit amount.ENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Interest amount type, in a coded form. For a full list of values see
OBInternalStatementInterestType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Total- x-namespaced-enum UK.OBIE.BalanceTransfer,UK.OBIE.Cash,UK.OBIE.EstimatedNext,UK.OBIE.Purchase,UK.OBIE.Total
-
Rate number
Rate for Statement Interest (where it is applicable in terms of a rate rather than an amount)
EXAMPLE: 0.05 -
RateType string
Interest amount type, in a coded form. For a full list of values see
OBInternalStatementInterestType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Total- x-namespaced-enum UK.OBIE.BalanceTransfer,UK.OBIE.Cash,UK.OBIE.EstimatedNext,UK.OBIE.Purchase,UK.OBIE.Total
-
Frequency string
Specifies the statement fee type requested. For a full list of values see
OBInternalStatementInterestFrequency1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Monthly- x-namespaced-enum UK.OBIE.Daily,UK.OBIE.HalfYearly,UK.OBIE.Monthly,UK.OBIE.PerStatementDate,UK.OBIE.Quarterly,UK.OBIE.Weekly,UK.OBIE.Yearly
-
Amount {
}Amount of money associated with the statement interest amount type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
-
StatementAmount [
]-
{
}Set of elements used to provide details of a generic amount for the statement resource.
-
CreditDebitIndicator string
Indicates whether the amount is a credit or a debit. For a full list of values see
OBInternalCreditDebitCodein OB_Internal_CodeSet here
Usage: A zero amount is considered to be a credit amount.ENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Amount type, in a coded form.
EXAMPLE: UK.OBIE.CreditLimit- x-namespaced-enum UK.OBIE.ArrearsClosingBalance,UK.OBIE.AvailableBalance,UK.OBIE.AverageBalanceWhenInCredit,UK.OBIE.AverageBalanceWhenInDebit,UK.OBIE.AverageDailyBalance,UK.OBIE.BalanceTransferClosingBalance,UK.OBIE.CashClosingBalance,UK.OBIE.ClosingBalance,UK.OBIE.CreditLimit,UK.OBIE.CurrentPayment,UK.OBIE.DirectDebitPaymentDue,UK.OBIE.FSCSInsurance,UK.OBIE.MinimumPaymentDue,UK.OBIE.PendingTransactionsBalance,UK.OBIE.PreviousClosingBalance,UK.OBIE.PreviousPayment,UK.OBIE.PurchaseClosingBalance,UK.OBIE.StartingBalance,UK.OBIE.TotalAdjustments,UK.OBIE.TotalCashAdvances,UK.OBIE.TotalCharges,UK.OBIE.TotalCredits,UK.OBIE.TotalDebits,UK.OBIE.TotalPurchases
-
Amount {
}Amount of money associated with the amount type.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
SubType string
Amount sub type, in a coded form. Default if not specified is BCUR of the account.
ENUM: BCUR, LCUR
-
-
LocalAmount {
}Optional component providing the equivalent of Amount in local currency.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
SubType string
The amount in the local market currency for which the asset is held. Default is Local Currency (LCUR) if not specified
ENUM: BCUR, LCUR
- default LCUR
-
-
-
-
StatementDateTime [
]-
{
}Set of elements used to provide details of a generic date time for the statement resource.
-
DateTime string
Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2024-05-29T00:00:00Z- format date-time
-
Type string
Date time type, in a coded form. For a full list of values see
OBInternalStatementDateTimeType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.NextStatement- x-namespaced-enum UK.OBIE.BalanceTransferPromoEnd,UK.OBIE.DirectDebitDue,UK.OBIE.LastPayment,UK.OBIE.LastStatement,UK.OBIE.NextStatement,UK.OBIE.PaymentDue,UK.OBIE.PurchasePromoEnd,UK.OBIE.StatementAvailable
-
-
-
StatementRate [
]-
{
}Set of elements used to provide details of a generic rate related to the statement resource.
-
Rate string
Rate associated with the statement rate type.
EXAMPLE: 0.224- maxLength 40
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
Type string
Statement rate type, in a coded form. For a full list of values see
OBInternalStatementRateType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.AnnualCash- x-namespaced-enum UK.OBIE.AnnualBalanceTransfer,UK.OBIE.AnnualBalanceTransferAfterPromo,UK.OBIE.AnnualBalanceTransferPromo,UK.OBIE.AnnualCash,UK.OBIE.AnnualPurchase,UK.OBIE.AnnualPurchaseAfterPromo,UK.OBIE.AnnualPurchasePromo,UK.OBIE.MonthlyBalanceTransfer,UK.OBIE.MonthlyCash,UK.OBIE.MonthlyPurchase
-
-
-
StatementValue [
]-
{
}Set of elements used to provide details of a generic number value related to the statement resource.
-
Value string
Value associated with the statement value type.
- minLength 1
- maxLength 40
-
Type string
Statement value type, in a coded form. For a full list of values see
OBInternalStatementValueType1Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.Credit- x-namespaced-enum UK.OBIE.AirMilesPoints,UK.OBIE.AirMilesPointsBalance,UK.OBIE.Credits,UK.OBIE.Debits,UK.OBIE.HotelPoints,UK.OBIE.HotelPointsBalance,UK.OBIE.RetailShoppingPoints,UK.OBIE.RetailShoppingPointsBalance
-
-
-
TotalValue {
}Combined sum of all Amounts in the accounts base currency
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
{
}-
StatusReasonCode string
Specifies the status reason in a code form. For a full description see
OBExternalStatusReason1CodehereEXAMPLE: U004- minLength 1
- maxLength 4
-
StatusReasonDescription string
Description supporting the StatusReasonCode.
EXAMPLE: Permissions field is missing- minLength 1
- maxLength 500
-
Path string
Recommended but optional reference to JSON path if relevant to the StatusReasonCode.
EXAMPLE: Data.Permissions- minLength 1
- maxLength 500
-
-
{
}Additional information that can not be captured in the structured fields and/or any other specific block.
ADDITIONAL PROPERTIES:
-
{
}Provides further details on an entry in the report.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
TransactionId string
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
- minLength 1
- maxLength 210
-
TransactionReference string
Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
- minLength 1
- maxLength 210
-
StatementReference [
]-
StatementReference string
Unique reference for the statement. This reference may be optionally populated if available.
EXAMPLE: 002- minLength 1
- maxLength 35
-
-
CreditDebitIndicator string
Indicates whether the transaction is a credit or a debit entry.
For a full list of enumeration values refer toOBInternalCreditDebitCodein OB_Internal_CodeSet hereENUM: Credit, Debit
-
Status string
Status of a transaction entry on the books of the account servicer.
For a full list of enumeration values refer toExternalEntryStatus1Codein ISO_External_CodeSet hereENUM: BOOK, FUTR, INFO, PDNG
-
TransactionMutability string
Specifies the Mutability of the Transaction record.
For a full list of enumeration values refer toOBInternalTransactionMutability1Codein OB_Internal_CodeSet hereENUM: Mutable, Immutable
-
BookingDateTime string
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
ValueDateTime string
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
TransactionInformation string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
- minLength 1
- maxLength 500
-
AddressLine string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
- minLength 1
- maxLength 70
-
Amount {
}Amount of money in the cash transaction entry.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
ChargeAmount {
}Transaction charges to be paid by the charge bearer.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
CurrencyExchange {
}Set of elements used to provide details on the currency exchange.
-
SourceCurrency string
Currency from which an amount is to be converted in a currency conversion.
- pattern ^[A-Z]{3,3}$
-
TargetCurrency string
Currency into which an amount is to be converted in a currency conversion.
- pattern ^[A-Z]{3,3}$
-
UnitCurrency string
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
- pattern ^[A-Z]{3,3}$
-
ExchangeRate number
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).
-
ContractIdentification string
Unique identification to unambiguously identify the foreign exchange contract.
- minLength 1
- maxLength 35
-
QuotationDate string
Date and time at which an exchange rate is quoted. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
InstructedAmount {
}Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
BankTransactionCode {
}Set of elements used to fully identify the type of underlying transaction resulting in an entry.
-
Code string
Specifies the family within a domain.
-
SubCode string
Specifies the sub-product family within a specific family.
-
-
ProprietaryBankTransactionCode {
}Set of elements to fully identify a proprietary bank transaction code.
-
Code string
Proprietary bank transaction code to identify the underlying transaction.
- minLength 1
- maxLength 35
-
Issuer string
Identification of the issuer of the proprietary bank transaction code.
- minLength 1
- maxLength 35
-
-
ExtendedProprietaryBankTransactionCodes [
]-
OBExtendedProprietaryBankTransactionCode {
}Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction
-
Code string
Proprietary bank transaction code to identify the underlying transaction.
- minLength 1
- maxLength 35
-
Issuer string
Identification of the issuer of the proprietary bank transaction code.
- minLength 1
- maxLength 35
-
Description string
Description of the code and its usage on the ASPSP channel
- minLength 1
- maxLength 500
-
-
-
Balance {
}Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
-
CreditDebitIndicator string
Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.
For a full list of enumeration values refer toOBInternalCreditDebitCodein OB_Internal_CodeSet hereENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Balance type, in a coded form.
For a full list of enumeration values refer toExternalBalanceType1Codein ISO_External_CodeSet here .ENUM: CLAV, CLBD, FWAV, INFO, ITAV, ITBD, OPAV, OPBD, PRCD, XPCD
EXAMPLE: CLAV -
Amount {
}Amount of money of the cash balance after a transaction entry is applied to the account..
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
MerchantDetails {
}Details of the merchant involved in the transaction.
-
MerchantName string
Name by which the merchant is known.
- minLength 1
- maxLength 350
-
MerchantCategoryCode string
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
- minLength 3
- maxLength 4
-
MerchantCategory1Name string
Tier 1 Merchant Category Name
- minLength 1
- maxLength 255
-
MerchantCategory2Name string
Tier 2 Merchant Category Name
- minLength 1
- maxLength 255
-
MerchantCategory3Name string
Tier 3 Merchant Category Name
- minLength 1
- maxLength 255
-
FcaCode string
Financial Conduct Authority Code
- minLength 1
- maxLength 255
-
FcaCategory string
Financial Conduct Authority Category
- minLength 1
- maxLength 255
-
CarbonScore {
}Carbon emission scoring details
-
totalKgCo2e number
Total Kg of CO2 emitted
- minLength 1
- maxLength 350
-
carbonModelVersion string
Carbon Model Version
- minLength 1
- maxLength 350
-
-
-
CreditorAgent {
}Financial institution servicing an account for the creditor.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
CreditorAccount {
}Unambiguous identification of the account of the creditor, in the case of a debit transaction.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
DebtorAgent {
}Financial institution servicing an account for the debtor.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
DebtorAccount {
}Unambiguous identification of the account of the debtor, in the case of a crebit transaction.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
CardInstrument {
}Set of elements to describe the card instrument used in the transaction.
For a full list of enumeration values refer toOBInternalCardSchemeType1Codein OB_Internal_CodeSet here-
CardSchemeName string
Name of the card scheme.
For a full list of enumeration values refer toOBInternalCardSchemeType1Codein OB_Internal_CodeSet hereENUM: AmericanExpress, Diners, Discover, MasterCard, VISA
-
AuthorisationType string
The card authorisation type.
For a full list of enumeration values refer toOBInternalCardAuthorisationType1Codein OB_Internal_CodeSet hereENUM: ConsumerDevice, Contactless, None, PIN
-
Name string
Name of the cardholder using the card instrument.
- minLength 1
- maxLength 70
-
Identification string
Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked.
- minLength 1
- maxLength 34
-
-
CategoryPurposeCode string
Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see
ExternalCategoryPurpose1Codein ISO_External_CodeSet hereENUM: BONU, CASH, CBLK, CCRD, CGWV, CIPC, CONC, CORT, DCRD, DIVI, DVPM, EPAY, FCDT, FCIN, FCOL, GOVT, GP2P, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P, OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, SWEP, TAXS, TOPG, TRAD, TREA, VATX, VOST, WHLD, ZABA
-
PaymentPurposeCode string
For a full list of enumeration values refer to
ExternalPurpose1Codein ISO_External_CodeSet hereENUM: BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, INTP, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GIFT, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RRCT, RRTP, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, IPAY, IPCA, IPDO, IPEA, IPEC, IPEW, IPPS, IPRT, IPU2, IPUW, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SPSP, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER, BOND, CABD, CAEQ, CBCR, DBCR, DICL, EQTS, FLCR, EFTC, EFTD, MOMA, RAPI, GAMB, LOTT, AMEX, SASW, AUCO, PCOM, PDEP, PLDS, PLRF, GAFA, GAHO, CPEN, DEPD, RETL, DEBT
- minLength 1
- maxLength 4
-
UltimateCreditor {
}Ultimate party to which an amount of money is due.
-
Name string
Name by which a party is known and which is usually used to identify that party.
- minLength 1
- maxLength 140
-
Identification string
Identification assigned by an institution.
- minLength 1
- maxLength 256
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
UltimateDebtor {
}Ultimate party that owes an amount of money to the (ultimate) creditor.
-
Name string
Name by which a party is known and which is usually used to identify that party.
- minLength 1
- maxLength 140
-
Identification string
Identification assigned by an institution.
- minLength 1
- maxLength 256
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
-
{
}Provides further details on an entry in the report.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
TransactionId string
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
- minLength 1
- maxLength 210
-
TransactionReference string
Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
- minLength 1
- maxLength 210
-
StatementReference [
]-
StatementReference string
Unique reference for the statement. This reference may be optionally populated if available.
EXAMPLE: 002- minLength 1
- maxLength 35
-
-
CreditDebitIndicator string
Indicates whether the transaction is a credit or a debit entry.
For a full list of enumeration values refer toOBInternalCreditDebitCodein OB_Internal_CodeSet hereENUM: Credit, Debit
-
Status string
Status of a transaction entry on the books of the account servicer.
For a full list of enumeration values refer toExternalEntryStatus1Codein ISO_External_CodeSet hereENUM: BOOK, FUTR, INFO, PDNG
-
TransactionMutability string
Specifies the Mutability of the Transaction record.
For a full list of enumeration values refer toOBInternalTransactionMutability1Codein OB_Internal_CodeSet hereENUM: Mutable, Immutable
-
BookingDateTime string
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
ValueDateTime string
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
AddressLine string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
- minLength 1
- maxLength 70
-
Amount {
}Amount of money in the cash transaction entry.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
ChargeAmount {
}Transaction charges to be paid by the charge bearer.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
CurrencyExchange {
}Set of elements used to provide details on the currency exchange.
-
SourceCurrency string
Currency from which an amount is to be converted in a currency conversion.
- pattern ^[A-Z]{3,3}$
-
TargetCurrency string
Currency into which an amount is to be converted in a currency conversion.
- pattern ^[A-Z]{3,3}$
-
UnitCurrency string
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
- pattern ^[A-Z]{3,3}$
-
ExchangeRate number
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).
-
ContractIdentification string
Unique identification to unambiguously identify the foreign exchange contract.
- minLength 1
- maxLength 35
-
QuotationDate string
Date and time at which an exchange rate is quoted. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
InstructedAmount {
}Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
BankTransactionCode {
}Set of elements used to fully identify the type of underlying transaction resulting in an entry.
-
Code string
Specifies the family within a domain.
-
SubCode string
Specifies the sub-product family within a specific family.
-
-
ProprietaryBankTransactionCode {
}Set of elements to fully identify a proprietary bank transaction code.
-
Code string
Proprietary bank transaction code to identify the underlying transaction.
- minLength 1
- maxLength 35
-
Issuer string
Identification of the issuer of the proprietary bank transaction code.
- minLength 1
- maxLength 35
-
-
ExtendedProprietaryBankTransactionCodes [
]-
OBExtendedProprietaryBankTransactionCode {
}Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction
-
Code string
Proprietary bank transaction code to identify the underlying transaction.
- minLength 1
- maxLength 35
-
Issuer string
Identification of the issuer of the proprietary bank transaction code.
- minLength 1
- maxLength 35
-
Description string
Description of the code and its usage on the ASPSP channel
- minLength 1
- maxLength 500
-
-
-
CardInstrument {
}Set of elements to describe the card instrument used in the transaction.
For a full list of enumeration values refer toOBInternalCardSchemeType1Codein OB_Internal_CodeSet here-
CardSchemeName string
Name of the card scheme.
For a full list of enumeration values refer toOBInternalCardSchemeType1Codein OB_Internal_CodeSet hereENUM: AmericanExpress, Diners, Discover, MasterCard, VISA
-
AuthorisationType string
The card authorisation type.
For a full list of enumeration values refer toOBInternalCardAuthorisationType1Codein OB_Internal_CodeSet hereENUM: ConsumerDevice, Contactless, None, PIN
-
Name string
Name of the cardholder using the card instrument.
- minLength 1
- maxLength 70
-
Identification string
Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked.
- minLength 1
- maxLength 34
-
-
CategoryPurposeCode string
Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see
ExternalCategoryPurpose1Codein ISO_External_CodeSet hereENUM: BONU, CASH, CBLK, CCRD, CGWV, CIPC, CONC, CORT, DCRD, DIVI, DVPM, EPAY, FCDT, FCIN, FCOL, GOVT, GP2P, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P, OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, SWEP, TAXS, TOPG, TRAD, TREA, VATX, VOST, WHLD, ZABA
-
PaymentPurposeCode string
For a full list of enumeration values refer to
ExternalPurpose1Codein ISO_External_CodeSet hereENUM: BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, INTP, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GIFT, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RRCT, RRTP, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, IPAY, IPCA, IPDO, IPEA, IPEC, IPEW, IPPS, IPRT, IPU2, IPUW, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SPSP, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER, BOND, CABD, CAEQ, CBCR, DBCR, DICL, EQTS, FLCR, EFTC, EFTD, MOMA, RAPI, GAMB, LOTT, AMEX, SASW, AUCO, PCOM, PDEP, PLDS, PLRF, GAFA, GAHO, CPEN, DEPD, RETL, DEBT
- minLength 1
- maxLength 4
-
-
{
}Provides further details on an entry in the report.
-
AccountId string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
EXAMPLE: 22289- minLength 1
- maxLength 40
-
TransactionId string
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
- minLength 1
- maxLength 210
-
TransactionReference string
Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
- minLength 1
- maxLength 210
-
StatementReference [
]-
StatementReference string
Unique reference for the statement. This reference may be optionally populated if available.
EXAMPLE: 002- minLength 1
- maxLength 35
-
-
CreditDebitIndicator string
Indicates whether the transaction is a credit or a debit entry.
For a full list of enumeration values refer toOBInternalCreditDebitCodein OB_Internal_CodeSet hereENUM: Credit, Debit
-
Status string
Status of a transaction entry on the books of the account servicer.
For a full list of enumeration values refer toExternalEntryStatus1Codein ISO_External_CodeSet hereENUM: BOOK, FUTR, INFO, PDNG
-
TransactionMutability string
Specifies the Mutability of the Transaction record.
For a full list of enumeration values refer toOBInternalTransactionMutability1Codein OB_Internal_CodeSet hereENUM: Mutable, Immutable
-
BookingDateTime string
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
ValueDateTime string
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
TransactionInformation string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
- minLength 1
- maxLength 500
-
AddressLine string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
- minLength 1
- maxLength 70
-
Amount {
}Amount of money in the cash transaction entry.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
ChargeAmount {
}Transaction charges to be paid by the charge bearer.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
CurrencyExchange {
}Set of elements used to provide details on the currency exchange.
-
SourceCurrency string
Currency from which an amount is to be converted in a currency conversion.
- pattern ^[A-Z]{3,3}$
-
TargetCurrency string
Currency into which an amount is to be converted in a currency conversion.
- pattern ^[A-Z]{3,3}$
-
UnitCurrency string
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
- pattern ^[A-Z]{3,3}$
-
ExchangeRate number
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).
-
ContractIdentification string
Unique identification to unambiguously identify the foreign exchange contract.
- minLength 1
- maxLength 35
-
QuotationDate string
Date and time at which an exchange rate is quoted. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
InstructedAmount {
}Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
BankTransactionCode {
}Set of elements used to fully identify the type of underlying transaction resulting in an entry.
-
Code string
Specifies the family within a domain.
-
SubCode string
Specifies the sub-product family within a specific family.
-
-
ProprietaryBankTransactionCode {
}Set of elements to fully identify a proprietary bank transaction code.
-
Code string
Proprietary bank transaction code to identify the underlying transaction.
- minLength 1
- maxLength 35
-
Issuer string
Identification of the issuer of the proprietary bank transaction code.
- minLength 1
- maxLength 35
-
-
ExtendedProprietaryBankTransactionCodes [
]-
OBExtendedProprietaryBankTransactionCode {
}Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction
-
Code string
Proprietary bank transaction code to identify the underlying transaction.
- minLength 1
- maxLength 35
-
Issuer string
Identification of the issuer of the proprietary bank transaction code.
- minLength 1
- maxLength 35
-
Description string
Description of the code and its usage on the ASPSP channel
- minLength 1
- maxLength 500
-
-
-
Balance {
}Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
-
CreditDebitIndicator string
Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.
For a full list of enumeration values refer toOBInternalCreditDebitCodein OB_Internal_CodeSet hereENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Balance type, in a coded form.
For a full list of enumeration values refer toExternalBalanceType1Codein ISO_External_CodeSet here .ENUM: CLAV, CLBD, FWAV, INFO, ITAV, ITBD, OPAV, OPBD, PRCD, XPCD
EXAMPLE: CLAV -
Amount {
}Amount of money of the cash balance after a transaction entry is applied to the account..
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
MerchantDetails {
}Details of the merchant involved in the transaction.
-
MerchantName string
Name by which the merchant is known.
- minLength 1
- maxLength 350
-
MerchantCategoryCode string
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
- minLength 3
- maxLength 4
-
MerchantCategory1Name string
Tier 1 Merchant Category Name
- minLength 1
- maxLength 255
-
MerchantCategory2Name string
Tier 2 Merchant Category Name
- minLength 1
- maxLength 255
-
MerchantCategory3Name string
Tier 3 Merchant Category Name
- minLength 1
- maxLength 255
-
FcaCode string
Financial Conduct Authority Code
- minLength 1
- maxLength 255
-
FcaCategory string
Financial Conduct Authority Category
- minLength 1
- maxLength 255
-
CarbonScore {
}Carbon emission scoring details
-
totalKgCo2e number
Total Kg of CO2 emitted
- minLength 1
- maxLength 350
-
carbonModelVersion string
Carbon Model Version
- minLength 1
- maxLength 350
-
-
-
CreditorAgent {
}Financial institution servicing an account for the creditor.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
CreditorAccount {
}Unambiguous identification of the account of the creditor, in the case of a debit transaction.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
DebtorAgent {
}Financial institution servicing an account for the debtor.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalFinancialInstitutionIdentification4Codein OB_Internal_CodeSet hereEXAMPLE: UK.OBIE.BICFI- x-namespaced-enum UK.OBIE.BICFI
-
Identification string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
- minLength 1
- maxLength 35
-
Name string
Name by which an agent is known and which is usually used to identify that agent.
EXAMPLE: Agent Name- minLength 1
- maxLength 140
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
DebtorAccount {
}Unambiguous identification of the account of the debtor, in the case of a crebit transaction.
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
Identification string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
EXAMPLE: 80200112344562- minLength 1
- maxLength 256
-
Name string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
EXAMPLE: Jane Smith- minLength 1
- maxLength 350
-
SecondaryIdentification string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
Proxy {
}Specifies an alternate assumed name for the identification of the account.
-
Identification string
Identification used to indicate the account identification under another specified name.
EXAMPLE: 2360549017905188- minLength 1
- maxLength 2048
-
Code string
Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values seeExternalProxyAccountType1Codein ISO_External_CodeSet hereENUM: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
EXAMPLE: TELE -
Type string
Type of the proxy identification.
- minLength 1
- maxLength 35
-
-
-
CardInstrument {
}Set of elements to describe the card instrument used in the transaction.
For a full list of enumeration values refer toOBInternalCardSchemeType1Codein OB_Internal_CodeSet here-
CardSchemeName string
Name of the card scheme.
For a full list of enumeration values refer toOBInternalCardSchemeType1Codein OB_Internal_CodeSet hereENUM: AmericanExpress, Diners, Discover, MasterCard, VISA
-
AuthorisationType string
The card authorisation type.
For a full list of enumeration values refer toOBInternalCardAuthorisationType1Codein OB_Internal_CodeSet hereENUM: ConsumerDevice, Contactless, None, PIN
-
Name string
Name of the cardholder using the card instrument.
- minLength 1
- maxLength 70
-
Identification string
Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked.
- minLength 1
- maxLength 34
-
-
CategoryPurposeCode string
Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see
ExternalCategoryPurpose1Codein ISO_External_CodeSet hereENUM: BONU, CASH, CBLK, CCRD, CGWV, CIPC, CONC, CORT, DCRD, DIVI, DVPM, EPAY, FCDT, FCIN, FCOL, GOVT, GP2P, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P, OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, SWEP, TAXS, TOPG, TRAD, TREA, VATX, VOST, WHLD, ZABA
-
PaymentPurposeCode string
For a full list of enumeration values refer to
ExternalPurpose1Codein ISO_External_CodeSet hereENUM: BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, INTP, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GIFT, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RRCT, RRTP, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, IPAY, IPCA, IPDO, IPEA, IPEC, IPEW, IPPS, IPRT, IPU2, IPUW, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SPSP, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER, BOND, CABD, CAEQ, CBCR, DBCR, DICL, EQTS, FLCR, EFTC, EFTD, MOMA, RAPI, GAMB, LOTT, AMEX, SASW, AUCO, PCOM, PDEP, PLDS, PLRF, GAFA, GAHO, CPEN, DEPD, RETL, DEBT
- minLength 1
- maxLength 4
-
UltimateCreditor {
}Ultimate party to which an amount of money is due.
-
Name string
Name by which a party is known and which is usually used to identify that party.
- minLength 1
- maxLength 140
-
Identification string
Identification assigned by an institution.
- minLength 1
- maxLength 256
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
UltimateDebtor {
}Ultimate party that owes an amount of money to the (ultimate) creditor.
-
Name string
Name by which a party is known and which is usually used to identify that party.
- minLength 1
- maxLength 140
-
Identification string
Identification assigned by an institution.
- minLength 1
- maxLength 256
-
LEI string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
EXAMPLE: IZ9Q00LZEVUKWCQY6X15- minLength 1
- maxLength 20
- pattern ^[A-Z0-9]{18,18}[0-9]{2,2}$
-
SchemeName string
Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer toOBInternalAccountIdentification4Codein OB_Internal_CodeSet here- x-namespaced-enum UK.OBIE.BBAN,UK.OBIE.IBAN,UK.OBIE.PAN,UK.OBIE.Paym,UK.OBIE.SortCodeAccountNumber,UK.OBIE.Wallet
-
PostalAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
-
{
}Set of elements to describe the card instrument used in the transaction.
For a full list of enumeration values refer toOBInternalCardSchemeType1Codein OB_Internal_CodeSet here-
CardSchemeName string
Name of the card scheme.
For a full list of enumeration values refer toOBInternalCardSchemeType1Codein OB_Internal_CodeSet hereENUM: AmericanExpress, Diners, Discover, MasterCard, VISA
-
AuthorisationType string
The card authorisation type.
For a full list of enumeration values refer toOBInternalCardAuthorisationType1Codein OB_Internal_CodeSet hereENUM: ConsumerDevice, Contactless, None, PIN
-
Name string
Name of the cardholder using the card instrument.
- minLength 1
- maxLength 70
-
Identification string
Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked.
- minLength 1
- maxLength 34
-
-
{
}Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
-
CreditDebitIndicator string
Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.
For a full list of enumeration values refer toOBInternalCreditDebitCodein OB_Internal_CodeSet hereENUM: Credit, Debit
EXAMPLE: Credit -
Type string
Balance type, in a coded form.
For a full list of enumeration values refer toExternalBalanceType1Codein ISO_External_CodeSet here .ENUM: CLAV, CLBD, FWAV, INFO, ITAV, ITBD, OPAV, OPBD, PRCD, XPCD
EXAMPLE: CLAV -
Amount {
}Amount of money of the cash balance after a transaction entry is applied to the account..
-
Amount string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
EXAMPLE: 1209.06- pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
-
Currency string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
EXAMPLE: GBP- pattern ^[A-Z]{3,3}$
-
-
-
{
}The Risk section is sent by the initiating party to the ASPSP.
It is used to specify additional details for risk scoring for Account Info.
-
string
Cap amount charged for a fee/charge
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
string
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
string
Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
- pattern ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
-
string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
string
Categorisation of fees and charges into standard categories.
ENUM: FCOT, FCRE, FCSV
-
string
Frequency at which the overdraft charge is applied to the account
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
string
How often is the overdraft fee/charge calculated for the account.
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
string
How frequently the fee/charge is applied to the account
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
string
How frequently the fee/charge is calculated
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: FEAC, FEAO, FECP, FEDA, FEHO, FEI, FEMO, FEOA, FEOT, FEPC, FEPH, FEPO, FEPS, FEPT, FEPTA, FEPTP, FEQU, FESM, FEST, FEWE, FEYE
-
string
Fee/Charge Type
ENUM: FEPF, FTOT, FYAF, FYAM, FYAQ, FYCP, FYDB, FYMI, FYXX
-
string
Methods of calculating interest
ENUM: ITCO, ITOT, ITSI
-
string
Type of interest rate, Fixed or Variable
ENUM: INFI, INVA
-
string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
ENUM: INBB, INFR, INGR, INLR, INNE, INOT
-
string
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
ENUM: INBB, INFR, INGR, INLR, INNE, INOT
-
string
Min Max type
ENUM: FMMN, FMMX
-
{
}-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
{
}Other application frequencies that are not available in the standard code list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
{
}Other calculation frequency which is not available in the standard code set.
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
{
}Other Fee type which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
{
}Other fee rate type code which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
{
}Other fee rate type which is not in the standard rate type list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
{
}Other application frequencies not covered in the standard code list
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
{
}Other calculation frequency which is not available in standard code set.
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
{
}Other fee rate type which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
{
}Other Fee/charge type which is not available in the standard code set
-
Code string
The four letter Mnemonic used within an XML file to identify a code
- pattern ^\\w{0,4}$
-
FeeCategory string
Categorisation of fees and charges into standard categories.
ENUM: FCOT, FCRE, FCSV
-
Name string
Long name associated with the code
- minLength 1
- maxLength 70
-
Description string
Description to describe the purpose of the code
- minLength 1
- maxLength 350
-
-
string
Overdraft fee type
ENUM: FBAO, FBAR, FBEB, FBIT, FBOR, FBOS, FBSC, FBTO, FBUB, FBUT, FTOT, FTUT
-
string
Period e.g. day, week, month etc. for which the fee/charge is capped
ENUM: PACT, PDAY, PHYR, PMTH, PQTR, PWEK, PYER
-
string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
string
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
string
Date on which the account and related basic services are effectively operational for the account owner. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
string
A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
EXAMPLE: PXSIF023- minLength 1
- maxLength 40
-
string
Number assigned by an agent to identify its customer.
EXAMPLE: 20202002- minLength 1
- maxLength 35
-
string
Collection of information that identifies a phone number, as defined by telecom services.
EXAMPLE: +442079460000- pattern \+[0-9]{1,3}-[0-9()+\-]{1,30}
-
string
Collection of information that identifies a mobile phone number, as defined by telecom services.
EXAMPLE: +447700900000- pattern \+[0-9]{1,3}-[0-9()+\-]{1,30}
-
string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
string
Date of most recent direct debit collection. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
{
}Set of elements to fully identify a proprietary bank transaction code.
-
Code string
Proprietary bank transaction code to identify the underlying transaction.
- minLength 1
- maxLength 35
-
Issuer string
Identification of the issuer of the proprietary bank transaction code.
- minLength 1
- maxLength 35
-
-
string
Rate associated with the statement rate type.
EXAMPLE: 0.224- maxLength 40
- pattern ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
-
string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
EXAMPLE: Towbar Club- minLength 1
- maxLength 35
-
string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
{
}Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction
-
Code string
Proprietary bank transaction code to identify the underlying transaction.
- minLength 1
- maxLength 35
-
Issuer string
Identification of the issuer of the proprietary bank transaction code.
- minLength 1
- maxLength 35
-
Description string
Description of the code and its usage on the ASPSP channel
- minLength 1
- maxLength 500
-
-
string
Specifies the Beneficiary Type.
ENUM: Trusted, Ordinary
EXAMPLE: Ordinary
-
string
The date on which the scheduled payment will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
string
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
EXAMPLE: SP03- minLength 1
- maxLength 40
-
string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
EXAMPLE: 87562298675897- minLength 1
- maxLength 34
-
string
A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.
EXAMPLE: Ben5- minLength 1
- maxLength 40
-
string
Date and time at which the statement period starts. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
EXAMPLE: 2017-07-12T00:00:00+00:00- format date-time
-
[
]-
{
}Frequency and format of statments for an account
-
Frequency string
For a full list of enumeration values refer to
OBFrequency2Codein OB_Internal_CodeSet hereENUM: YEAR, DAIL, INDA, MNTH, QURT, MIAN, TEND, MOVE, WEEK
-
CommunicationMethod string
For a full list of enumeration values see
OBExternalCommunicationMethod2Codein OB_Internal_CodeSet hereENUM: EMAL, FAXI, FILE, ONLI, POST
-
Format string
For a full list of enumeration values refer to
ExternalDocumentFormat1Codein OB_Internal_CodeSet hereENUM: DPDF, DXML, SDSH, WORD, XSLT
-
DeliveryAddress {
}Information that locates and identifies a specific address, as defined by postal services.
-
AddressType string
Identifies the nature of the postal address.
For a full set of codes seeOBAddressType2Codein OB_Internal_CodeSet here .ENUM: BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT
EXAMPLE: BIZZ -
Department string
Identification of a division of a large organisation or building.
EXAMPLE: Finance- minLength 1
- maxLength 70
-
SubDepartment string
Identification of a sub-division of a large organisation or building.
EXAMPLE: Payroll- minLength 1
- maxLength 70
-
StreetName string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
BuildingNumber string
Number that identifies the position of a building on a street.
EXAMPLE: 11- minLength 1
- maxLength 16
-
BuildingName string
Name of a referenced building.
- minLength 1
- maxLength 140
-
Floor string
Number that identifies the level within a building
EXAMPLE: 11- minLength 1
- maxLength 70
-
UnitNumber string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
Room string
Information that locates and identifies a room to form part of an address
EXAMPLE: Basement 03- minLength 1
- maxLength 70
-
PostBox string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
EXAMPLE: PO Box 123456- minLength 1
- maxLength 16
-
TownLocationName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
DistrictName string
Number that of the regional area, known as a district, which forms part of an address
EXAMPLE: Greater London- minLength 1
- maxLength 140
-
CareOf string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
EXAMPLE: Jane Smith- minLength 1
- maxLength 140
-
PostCode string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
EXAMPLE: EC2N 4AG- minLength 1
- maxLength 16
-
TownName string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
CountrySubDivision string
Identifies a subdivision of a country such as state, region, county.
- minLength 1
- maxLength 35
-
Country string
Nation with its own government.
- pattern ^[A-Z]{2,2}$
-
AddressLine [
]- minItems 0
- maxItems 7
-
string
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- minLength 1
- maxLength 70
-
-
-
-
string
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
EXAMPLE: 8sfhke-sifhkeuf-97813- minLength 1
- maxLength 40
-
string
Unique reference for the statement. This reference may be optionally populated if available.
EXAMPLE: 002- minLength 1
- maxLength 35
-
string
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
string
Name of a street or thoroughfare.
EXAMPLE: Bank Street- minLength 1
- maxLength 140
-
string
Time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: T10:43:07+00:00
- format time
-
string
Name of a built-up area, with defined boundaries, and a local government.
EXAMPLE: London- minLength 1
- maxLength 140
-
string
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
- minLength 1
- maxLength 210
-
string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
- minLength 1
- maxLength 500
-
string
Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
- minLength 1
- maxLength 210
-
string
Number that identifies the unit of a specific address .
EXAMPLE: A88- minLength 1
- maxLength 16
-
string
Value associated with the statement value type.
- minLength 1
- maxLength 40
-
string
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- format date-time
-
{
}-
id integer
- format int64
-